Index: contributing.html
===================================================================
--- contributing.html (revision 1691900)
+++ contributing.html (working copy)
@@ -6,21 +6,30 @@
If you don't know Java or Scala you can still contribute to the project. An important area is the clients. We want to have high quality, well documented clients for each programming language. These, as well as the surrounding ecosystem of integration tools that people use with Kafka, are critical aspects of the project.
-Nor is code the only way to contribute to the project. We strongly value documentation and gladly accept patches against the docs.
+Nor is code the only way to contribute to the project. We strongly value documentation and gladly accept improvements to the documentation.
-
Contributing a Patch
-To submit a patch for inclusion please do the following:
+Contributing A Code Change
+
+To submit a change for inclusion, please do the following:
+
- - Create a patch that applies cleanly against trunk.
- - If the patch is non-trivial we would prefer it come with some unit tests that cover the new functionality.
+ - If the change is non-trivial please include some unit tests that cover the new functionality.
- If you are introducing a completely new feature or API it is a good idea to start a wiki and get consensus on the basic design first.
- Make sure you have observed the recommendations in the style guide.
+ - Follow the detailed instructions in Contributing Code Changes.
+ - It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things).
+
+
+Contributing A Change To The Website
+
+To submit a change for inclusion please do the following:
+
+
+ - Create a patch that applies cleanly against SVN trunk.
- Open a JIRA ticket describing the patch and attach your patch to the JIRA. Include in the JIRA information about the issue and the approach you took in fixing it (if this isn't obvious). Also, mark the jira as "Patch Available" by clicking on the "Submit Patch" button (this is done automatically if you use the code review tool below). Creating the JIRA will automatically send an email to the developer email list alerting us of the new issue.
- It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things). If the patch needs improvement, the reviwer will mark the jira back to "In Progress" after reviewing.
-If you will be contributing multiple non-trivial patches it may be worth using our code review script which helps to integrate git, JIRA, and review board. You can find instructions on this tool here.
-
Finding A Project To Work On
The easiest way to get started working with the code base is to pick up a really easy JIRA and work on that. This will help you get familiar with the code base, build system, review process, etc. We flag these kind of starter bugs here.