kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jkr...@apache.org
Subject svn commit: r1612144 - in /kafka/site: contributing.html projects.html styles.css
Date Sun, 20 Jul 2014 18:32:23 GMT
Author: jkreps
Date: Sun Jul 20 18:32:23 2014
New Revision: 1612144

URL: http://svn.apache.org/r1612144
Improve contributor page.


Modified: kafka/site/contributing.html
URL: http://svn.apache.org/viewvc/kafka/site/contributing.html?rev=1612144&r1=1612143&r2=1612144&view=diff
--- kafka/site/contributing.html (original)
+++ kafka/site/contributing.html Sun Jul 20 18:32:23 2014
@@ -2,7 +2,14 @@
 <h1>How To Contribute</h1>
-We are always very happy to have code contributions whether for trivial cleanups or big new
features. To submit a patch for inclusion please do the following:
+We are always very happy to have contributions, whether for trivial cleanups or big new features.
+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 a critical part 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.
+<h2>Contributing a Patch</h2>
+To submit a patch for inclusion please do the following:
 	<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>
@@ -12,6 +19,17 @@ We are always very happy to have code co
 	<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>
-You can find some help using git to contribute, rebase, and create patches <a href="https://cwiki.apache.org/confluence/display/KAFKA/Patch+submission+and+review">here</a>.
+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 get familiar with the code base, build, review process, etc.
We flag these kind of easy 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>.
+Once you have gotten through the basic process of checking in code, you may want to move
on to a more substantial project. We try to curate this kind of project as well, and you can
find these <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20KAFKA%20AND%20labels%20%3D%20project%20AND%20status%20%3D%20Open">here</a>.
+<h2>Becoming a Committer</h2>
+We are always interested in adding new contributors. What we look for a series of contributions,
good taste, and an ongoing interest in the project. If you are interested in this let one
of the existing committers know and they can help guide you through the process.
 <!--#include virtual="includes/footer.html" -->

Modified: kafka/site/styles.css
URL: http://svn.apache.org/viewvc/kafka/site/styles.css?rev=1612144&r1=1612143&r2=1612144&view=diff
--- kafka/site/styles.css (original)
+++ kafka/site/styles.css Sun Jul 20 18:32:23 2014
@@ -27,6 +27,7 @@ h4 {
 a {
 	color: #2e4a8e;
+	font-weight: bold;
 	text-decoration: none;
 #everything {

View raw message