[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Google Summer of Code Students: A guide to getting started

From: David James <djames_at_collab.net>
Date: 2006-05-31 07:27:47 CEST

Google is funding four students to work on Subversion this summer for
the Google Summer of Code. Please join me in welcoming these students
to the Subversion community and helping them get started in
contributing to the Subversion project.

The Google Summer of Code students for Summer 2006:
  * Walter Mundt: Improving the Python Bindings
  * David Mahakian: Svnserve Logging
  * Vlad Georgescu: SASL authentication support for ra_svn
  * Artem Egorkine: Dramatically faster path-based authorization over DAV

I've outlined a few tips below on how to help these students get
started on the Subversion project.

Progress report: Current Status for Summer of Code Projects
===========================================================
   Walter Mundt has already submitted his proposal and a few initial
patches to the dev@ list. His proposal and patches were greeted warmly
on the dev@ list.
   David Mahakian submitted an example patch to the dev@ list. It was
accepted into Subversion. See
<http://svn.haxx.se/dev/archive-2006-05/0563.shtml>. David Mahakian
also submitted a copy of his proposal to
<http://svn.haxx.se/dev/archive-2006-05/0410.shtml>, but has not
received any feedback yet.
   Vlad Georgescu submitted an example patch to the dev@ list. It was
accepted into Subversion. See
<http://svn.haxx.se/dev/archive-2006-05/0399.shtml>.
   Artem Egorkine has sent me a personal mail to let me know he's
started work on measuring the performance costs of Subversion's
current authz scheme. I've encouraged him to send a mail to the dev@
list to introduce himself there, so you should hear from him soon.

Students: Introduce yourself
============================

Students: Please follow the steps in this guide to introduce yourself
to the Subversion community.

  1. Subscribe to the dev@subversion.tigris.org and
svn@subversion.tigris.org mailing lists. In order to manage the volume
of mail on these lists, you will need to set up mail filters. See the
"Setting up mail filters" section below for instructions.
  2. Send your proposal to dev@subversion.tigris.org.
  3. Write a useful patch for Subversion and submit it to
dev@subversion.tigris.org with a nice log message. If this is your
first Subversion patch, please try to keep your patch simple and
obviously correct. For more details, see the "Submitting patches"
section.

Students: Setting up mail filters
=================================

You may want to set up filters in your mail client so that
Subversion-related emails are filtered into a specific folder or
label. However, please ensure that any emails which mention your exact
name or email address are prioritized for quick reading. An example
set of mail filters are included in Appendix A.

Students: Submitting patches
============================

Mail patches to dev@subversion.tigris.org, with a subject line that
contains the word "PATCH" in all uppercase, for example

   Subject: [PATCH] fix for rev printing bug in svn status

A patch submission should contain one logical change; please don't mix
N unrelated changes in one submission send N separate emails
instead.

You can put the patch's log message in the body of the email, or at
the top of the patch attachment (see below). Either way, it should
follow the guidelines given in Writing log messages, and be enclosed
in triple square brackets, like so:

   [[[
   Fix issue #1729: Don't crash because of a missing file.

   * subversion/libsvn_ra_ansible/get_editor.c
     (frobnicate_file): Check that file exists before frobnicating.
   ]]]

The patch itself should be in unified diff format (e.g., "svn diff" or
"diff -u"). Attach the patch as a text file (for example,
"frobnicate-patch.txt")

Students: Soliciting feedback
=============================

When you first submit your patch by email, you might not receive
feedback right away. Here's a few tips to receive quick feedback.
   1) Before submitting your patch, poll for interest on the
"#svn-dev" channel on irc.freenode.net. Check if you can get a few
developers to "sanity check" your patch before you submit it to the
list. Any developers who helped with this process should be added to
the "CC" list when you submit your patch.
   2) Pick a good subject line. It should start with "[PATCH]", and
describe briefly what you changed, and where. For example:
http://svn.haxx.se/dev/archive-2006-05/0847.shtml
   3) Include tests with your patch. It's much, much easier to review
a patch if it includes tests which make sure the changes work as
intended.

Students: First patch guidelines
================================

Some good topics for a first patch:
  1. Typo fixes / documentation updates. These types of fixes are
easy, useful, and obviously correct. For example, see
http://svn.haxx.se/dev/archive-2006-05/0552.shtml
  2. New tests. New tests tend to be simple and easy to review. Even
if we don't understand the area of Subversion that you're working on,
we can thoroughly test your patch by "just running it". For example,
see http://svn.haxx.se/dev/archive-2006-05/0308.shtml
  3. Bug fix plus test. Bug fixes can be tricky to figure out, but if
you include a test with your patch, they're easy to review.

Appendix A: Example Mail Filters
================================

1) Apply label "#svn-dev" for all mails sent to dev@subversion.tigris.org
    Matches: to:dev@subversion.tigris.org
    Do this: Apply label "#svn-dev"

2) Apply label "#svn-commit" for all mails sent to svn@subversion.tigris.org
    Matches: to:svn@subversion.tigris.org
    Do this: Apply label "#svn-commit"

3) If the email mentions my name or email, put it in the inbox.
   Matches: to:dev@subversion.tigris.org OR
to:svn@subversion.tigris.org -{David-James OR djames OR james82}
   Do this: Skip Inbox

You'll of course need to adjust the names and email addresses in these
filters accordingly.

-- 
David James -- http://www.cs.toronto.edu/~james
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed May 31 07:28:18 2006

This is an archived mail posted to the Subversion Dev mailing list.