[jira] [Commented] (KAFKA-96) Add a style guide for kafka site

["Jun Rao (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-96?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13084739#comment-13084739 ] 

Jun Rao commented on KAFKA-96:
------------------------------

That's a good list. I agree with most of the items. I want to add 1 more:
* avoid duplicating code when possible.

About enforcing backward compatibility. I agree that we should try to do that as much as we can. However, for major changes like replication. This is going to be hard. For example, an old client will not understand the concept of logical partitions, replicas of a partition, the leader of a partition, etc. One benefit of a streaming engine is that one can upgrade by creating a new instance of the brokers using the new version, upgrade the producer and point it to the new brokers, drain the old consumer and finally upgrade the consumer and point it to the new brokers. This should still allow minimal down time. Also, should backward compatibility be maintained just for the previous version or for all old versions? If it's the latter, the code may become harder and harder to maintain going forward.

> Add a style guide for kafka site
> --------------------------------
>
>                 Key: KAFKA-96
>                 URL: https://issues.apache.org/jira/browse/KAFKA-96
>             Project: Kafka
>          Issue Type: Improvement
>          Components: website
>            Reporter: Jay Kreps
>            Assignee: Jay Kreps
>            Priority: Minor
>         Attachments: kafka_coding_guide.txt
>
>
> We have actual contributors now (yay!) so it might be good to consider having a style/coding guide that covers what is expected for new development or submitted patches. In my experience these guidelines are always a bit personal, and only work if there is real agreement amongst contributors. I have written up the guide which reflects at least the early code. I would love to get people's feedback on whether anything is missing or questionable and see if we could adopt these.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira