kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject svn commit: r1692922 - /kafka/site/contributing.html
Date Mon, 27 Jul 2015 18:02:51 GMT
Author: guozhang
Date: Mon Jul 27 18:02:51 2015
New Revision: 1692922

URL: http://svn.apache.org/r1692922
Log:
update contribution page to point to the new github RP wiki

Modified:
    kafka/site/contributing.html

Modified: kafka/site/contributing.html
URL: http://svn.apache.org/viewvc/kafka/site/contributing.html?rev=1692922&r1=1692921&r2=1692922&view=diff
==============================================================================
--- kafka/site/contributing.html (original)
+++ kafka/site/contributing.html Mon Jul 27 18:02:51 2015
@@ -6,21 +6,31 @@ We are always very happy to have contrib
 <p>
 If you don't know Java or Scala you can still contribute to the project. An important area
is the <a href="https://cwiki.apache.org/confluence/display/KAFKA/Clients">clients</a>.
We want to have high quality, well documented clients for each programming language. These,
as well as the surrounding <a href="https://cwiki.apache.org/confluence/display/KAFKA/Ecosystem">ecosystem</a>
of integration tools that people use with Kafka, are critical aspects of the project.
 <p>
-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.
+
+<h2>Contributing A Code Change</h2>
+
+To submit a change for inclusion, please do the following:
 
-<h2>Contributing a Patch</h2>
-To submit a patch for inclusion please do the following:
 <ul>
-	<li>Create a patch that applies cleanly against trunk.</li>
-	<li>If the patch is non-trivial we would prefer it come with some unit tests that
cover the new functionality.</li>
+	<li>If the change is non-trivial please include some unit tests that cover the new
functionality.</li>
 	<li>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.</li>
 	<li>Make sure you have observed the recommendations in the <a href="coding-guide.html">style
guide</a>.</li>
+	<li>Follow the detailed instructions in <a href="https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Code+Changes">Contributing
Code Changes</a>.</li>
+	<li>Note that if the change is related to user-facing protocols / interface / configs,
etc, you need to make the corresponding change on the documentation as well. For wiki page
changes feel free to edit the page content directly (you may need to contact us to get the
permission first if it is your first time to edit on wiki); for website doc changes please
follow the steps below to submit another patch as well, except it can be under the same JIRA
as the code change and you do not need to create a new JIRA for it.
+	<li>It is our job to follow up on patches in a timely fashion. <a href="mailto:
dev@kafka.apache.org">Nag us</a> if we aren't doing our job (sometimes we drop things).</li>
+</ul>
+
+<h2>Contributing A Change To The Website</h2>
+
+To submit a change for inclusion please do the following:
+
+<ul>
+	<li>Create a patch that applies cleanly against <a href="http://svn.apache.org/repos/asf/kafka/site/">SVN
trunk</a>.</li>
 	<li>Open a <a href="https://issues.apache.org/jira/browse/KAFKA">JIRA</a>
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.</li>
 	<li>It is our job to follow up on patches in a timely fashion. <a href="mailto:
dev@kafka.apache.org">Nag us</a> 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.</li>
 </ul>
 
-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 <a href="https://cwiki.apache.org/confluence/display/KAFKA/Patch+submission+and+review">here</a>.
-
 <h2>Finding A Project To Work On</h2>
 
 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 <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20KAFKA%20AND%20labels%20%3D%20newbie%20AND%20status%20%3D%20Open">here</a>.



Mime
View raw message