[GitHub] kafka-site pull request #73: Add coding guidelines for Streams API

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/kafka-site/pull/73


---

[GitHub] kafka-site pull request #73: Add coding guidelines for Streams API

[mjsax]

Github user mjsax commented on a diff in the pull request:

https://github.com/apache/kafka-site/pull/73#discussion_r137037867
  
--- Diff: coding-guide.html ---
@@ -102,6 +102,47 @@
We should attempt to maintain API compatibility when 
possible, though at this point in the project's lifecycle it is more important 
to make things good rather than avoid breakage.

 
+   Streams API
+   Kafka's Streams API (aka Kafka Streams) uses a few more 
additional coding guidelines.
+   All contributors should follow those the get a high 
quality and uniform code base.
+   Some rules help to simplify PR reviews and thus make 
the live of all contributors easier.
+   
+   Use final when possible.
+This holds for all class members, local 
variables, loop variables, and method parameters.
+   Write modular and thus testable code. Refactor if 
necessary!
+   Avoid large PRs (recommended is not more the 500 
lines per PR).
+Many JIRAs requires larger code changes; thus, 
split the work in multiple PRs and create according sub-task on the JIRA to 
track the work.
+   All public APIs must have JavaDocs.
+   Verify if JavaDocs are still up to date or if they 
need to be updated.
+   JavaDocs: Write grammatically correct sentences and 
use punctuation marks correctly.
+   Use proper markup (e.g., {@code 
null}).
+   Update the documentation on the Kafka webpage 
(i.e., within folder docs/.
+Doc changes are not additional work (i.e. no 
follow up PRs) but part of the actuall PR (can also be a sub-tasks).
--- End diff --

Thanks @Kamal15 @Sharon2017 !


---

[GitHub] kafka-site pull request #73: Add coding guidelines for Streams API

[Sharon2017]

Github user Sharon2017 commented on a diff in the pull request:

https://github.com/apache/kafka-site/pull/73#discussion_r136896770
  
--- Diff: coding-guide.html ---
@@ -102,6 +102,47 @@
We should attempt to maintain API compatibility when 
possible, though at this point in the project's lifecycle it is more important 
to make things good rather than avoid breakage.

 
+   Streams API
+   Kafka's Streams API (aka Kafka Streams) uses a few more 
additional coding guidelines.
+   All contributors should follow those the get a high 
quality and uniform code base.
+   Some rules help to simplify PR reviews and thus make 
the live of all contributors easier.
+   
+   Use final when possible.
+This holds for all class members, local 
variables, loop variables, and method parameters.
+   Write modular and thus testable code. Refactor if 
necessary!
+   Avoid large PRs (recommended is not more the 500 
lines per PR).
+Many JIRAs requires larger code changes; thus, 
split the work in multiple PRs and create according sub-task on the JIRA to 
track the work.
+   All public APIs must have JavaDocs.
+   Verify if JavaDocs are still up to date or if they 
need to be updated.
+   JavaDocs: Write grammatically correct sentences and 
use punctuation marks correctly.
+   Use proper markup (e.g., {@code 
null}).
+   Update the documentation on the Kafka webpage 
(i.e., within folder docs/.
+Doc changes are not additional work (i.e. no 
follow up PRs) but part of the actuall PR (can also be a sub-tasks).
--- End diff --

Two more nits:
> All contributors should follow those the get a high quality and uniform 
code base.

Nit: follow those the get -> follow those to get

>  thus make the live of all contributors easier

Nit: the live -> the life


---

[GitHub] kafka-site pull request #73: Add coding guidelines for Streams API

[Kamal15]

Github user Kamal15 commented on a diff in the pull request:

https://github.com/apache/kafka-site/pull/73#discussion_r136894052
  
--- Diff: coding-guide.html ---
@@ -102,6 +102,47 @@
We should attempt to maintain API compatibility when 
possible, though at this point in the project's lifecycle it is more important 
to make things good rather than avoid breakage.

 
+   Streams API
+   Kafka's Streams API (aka Kafka Streams) uses a few more 
additional coding guidelines.
+   All contributors should follow those the get a high 
quality and uniform code base.
+   Some rules help to simplify PR reviews and thus make 
the live of all contributors easier.
+   
+   Use final when possible.
+This holds for all class members, local 
variables, loop variables, and method parameters.
+   Write modular and thus testable code. Refactor if 
necessary!
+   Avoid large PRs (recommended is not more the 500 
lines per PR).
+Many JIRAs requires larger code changes; thus, 
split the work in multiple PRs and create according sub-task on the JIRA to 
track the work.
+   All public APIs must have JavaDocs.
+   Verify if JavaDocs are still up to date or if they 
need to be updated.
+   JavaDocs: Write grammatically correct sentences and 
use punctuation marks correctly.
+   Use proper markup (e.g., {@code 
null}).
+   Update the documentation on the Kafka webpage 
(i.e., within folder docs/.
+Doc changes are not additional work (i.e. no 
follow up PRs) but part of the actuall PR (can also be a sub-tasks).
--- End diff --

@mjsax 

nit: actuall -> actual


---

[GitHub] kafka-site pull request #73: Add coding guidelines for Streams API

[mjsax]

GitHub user mjsax opened a pull request:

https://github.com/apache/kafka-site/pull/73

Add coding guidelines for Streams API



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/mjsax/kafka-site streams-coding-guidelines

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/kafka-site/pull/73.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #73


commit 91fa8d1360c40aa659c3edda46d400cf8306ac6d
Author: Matthias J. Sax 
Date:   2017-09-04T22:38:53Z

Add coding guidelines for Streams API




---