Page History

...

Before you start, send a message to the ZooKeeper developer mailing list, or file a bug report in Jira. Describe your proposed changes and check that they fit in with what others are doing and have planned for the project. Be patient, it may take folks a while to understand your requirements.

...

• All public classes and methods should have informative Javadoc comments.
  • Do not use @author tags.
• Code should be formatted according to Sun's conventions, with these exceptions:
  • Indent four spaces per level, not two or six or eight, etc... four.
  • No tabs for indentation, spaces only
• Contributions should pass existing unit tests.
• New unit tests should be provided to demonstrate bugs and fixes. JUnit is our test framework:
  • You must implement a class that extends junit.framework.TestCase and whose class name ends with Test.
  • Define methods within your class whose names begin with test, and call JUnit's many assert methods to verify conditions; these methods will be executed when you run ant test.
  • By default, do not let tests write any temporary files to /tmp. Instead, the tests should write to the location specified by the test.build.data system property.
  • Place your class in the src/java/test tree.
  • ClientTest.java is an example of a client-server test.
  • You can run all the unit test with the command ant test, or you can run a specific unit test with the command ant -Dtestcase=<class name without package prefix> test (for example ant -Dtestcase=ClientTest test)

Understanding Ant

ZooKeeper is built by Ant, a Java building tool. This section will eventually describe how Ant is used within ZooKeeper. To start, simply read a good Ant tutorial. The following is a good tutorial, though keep in mind that ZooKeeper isn't structured according to the ways outlined in the tutorial. Use the tutorial to get a basic understand of Ant but not to understand how Ant is used for Hadoop:

Good Ant tutorial: http://i-proving.com/2005/10/31/ant-tutorial

Contribute Work via Github Pull Request

...

To use this target, you must run it from a clean workspace (ie git status shows no modifications or additions). From your clean workspace, run:

ant testmvn verify spotbugs:check checkstyle:check -Pfull-build -Dsurefire-forkcount=4

At the end, you should get a message on your console that indicates success.Some things to note:

• you may need to explicitly set ANT_HOME. Running ant -diagnostics will tell you the default value on your system.
• you may need to explicitly set JAVA_HOME.

Please make sure that all unit tests succeed before submitting pull request and that no new javac compiler warnings are introduced by your pull request

> cd zookeeper-trunk
> ant -Djavac.args="-Xlint -Xmaxwarns 1000" clean test tar

After a while, if you see

...

Please also check the javadoc.

> ant javadoc mvn install -DskipTests -pl zookeeper-docs
> firefox build/docs/api/index.html

...

• try to adhere to the coding style of files you edit;
• comment code whose function or rationale is not obvious;

Use GitHub’s "Co-authored-by" when there are multiple authors

Note: This is in case of manual copies, ToDo for me: I will check the commit script to integrate this functionality

There are occasions when there are multiple author for a patch. For example when there is a patch that is abandoned by its original author for any reason, and it can no longer be merged, or it's unfinished, someone might pick it up and finish it. (After asking the original author if he is still working on it or not).

In these occasions, we should also attribute the original author by adding one or more Co-authored-by trailers to the commit’s message. See the GitHub documentation for "Creating a commit with multiple authors".

As this is a GitHub feature, Co-author will show up on GitHub's statistics.

In short, these are the steps to add Co-authors that will be tracked by GitHub:

1. Collect the name and email address for each co-author.

2. Commit the change, but after your commit description, instead of a closing quotation, add two empty lines. (Do not close the commit message with a quotation mark)

3. On the next line of the commit message, type Co-authored-by: name <name@example.com>. After the co-author information, add a closing quotation mark.

Here is the example from the GitHub page, using 2 Co-authors:

$ git commit -m "Refactor usability tests.
>
>
Co-authored-by: name <name@example.com>
Co-authored-by: another-name <another-name@example.com>"

Final Checks on Pull Request

Please note that the attachment should be granted license to ASF for inclusion in ASF works (as per the Apache License §5).

Folks should run ant clean test javadoc before a full check (mvn verify spotbugs:check checkstyle:check -Pfull-build -Dsurefire-forkcount=4) before submitting pull request. Tests should all pass. Javadoc should report no warnings or errors. Jenkin's tests are meant to double-check things, and not be used as a primary patch tester, which would create too much noise on the mailing list and in Jira. Submitting patches that fail Jenkins testing is frowned on, (unless the failure is not actually due to the patch).

...

In this case, please check the Jenkins output by following the "Details" link, and fix the issue, and try trigger a Jenkins build again. There are two these ways to trigger a Jenkins build:

• Close and reopen the pull request. This is the recommended approach, and only the contributor who owns the pull request can do this.
• Update the PR by pushing a new commit or amend the previous commit (git commit --amend). This is also recommended approach and only contributor who owns the pull request can do this.
• A Any committer or PMC member who has admin access to Apache Jenkins infrastructure can rebuild the same Jenkins job. This is not recommended, because due to permission issues, the rebuild Jenkins job would fail to push the results back to git, and you will see something like this, regardless of the job succeeded or not.
  (actually anyone who is part of 'apache' github organization) can trigger the job just by adding a comment with the magic phrases:
  • 'retest ant build' in order to re run ANT based build
  • 'retest maven build' in order to re run MAVEN based build (update on Sep, 2020 - currently this trigger phrase is broken. Workaround is for committers to manually trigger the job in CI admin UI, or for contributors to do a commit with a new SHA - e.g. commit --amend then push to remote to trigger the job).
• Note for administrators: configuration of these phrases are in the precommit Jenkins jobs, it is using the GitHub Pull Request builder plugin)
  

For contributors who owns the pull request: please make sure to get a green build to prepare the patch in a landing state.

...

Committing Guidelines for committers

...

Jira Guidelines

Please comment on issues in Jira, making their concerns known. Please also vote for issues that are a high priority for you.

...