|From:||Kevin Brown (et...@google.com)|
|Date:||May 10, 2008 1:00:26 am|
I'm trying to gather some additions to the contributors page of the shindig site. I'd like to address a few issues that have come up with patches from non-committers. Here's what I have so far:
- Patches should be attached to the JIRA issue tracker. Patches sent via email will likely just be forgotten.
- All existing tests must pass after the patch is applied. If any tests fail, you must also patch the code that is now failing (either by updating the test, or modifying the code path as appropriate). If you need to make any major changes to other code that is not directly related to your change, please include notes to that effect in the JIRA ticket. If you're unsure of what to do, email shindig-dev@, or the component lead for the code you're patching.
- Patches should be as small and focused as possible. The smaller they are, the easier it is to avoid conflicts and for committers to review them.
- Patch should be against a relatively recent version of Shindig so as to avoid merge conflicts; ideally, the patch should be against HEAD at the time of creation. Committers will do our best to resolve any minor merge issues that occur between patch submission and commit time, though we may not be able to do this in the event of major conflicts.
- Committers must reference the issue when committing the patch. The ideal format is something like "Applying SHINDIG-XXX, submitted by <name of user that submitted it". This will allow automatic status updates for the associated JIRA tickets.