...
- Fork the Github repository at https://github.com/apache/incubator-distributedlog if you haven't already.
- Clone your fork, create a new branch, push commits to the branch (review the [DistributedLog Coding Guidelines] , if you haven't already).
- Consider whether documentation or tests need to be added or updated as part of the change, and add them as needed.
- Doc changes should be submitted along with code change.
- New server configuration settings should be added and documented in configuration file templates, and also documented in Documentation.
- Run all tests with "mvn clean apache-rat:check package findbugs:check" to verify that the code compiles, passes tests and passes findbugs checks.
- Open a pull request against the master branch of https://github.com/apache/incubator-distributedlog. (Only in special cases would the PR be opened against other branches.)
- The PR title should be of the form DL-XXXX: Title, where DL-XXXX is the relevant JIRA and Title may be the JIRA's title or a more specific title describing the PR itself.
- If the pull request is still a work in progress, and so is not ready to be merged, but needs to be pushed to Github to facilitate review, then add [WIP] after the JIRA id.
- Consider identifying committers or other contributors who have worked on the code being changed. Find the file(s) in GitHub and click "Blame" to see a line-by-line annotation of who changed the code last. You could add @username in the PR description to ping them immediately.
- Please state that the contribution is your original work and that you license the work to the project under the project's open source license.
- A comment with information about the pull request will be added to the JIRA ticket.
- Change the status of the JIRA to "Patch Available" if it is ready for review.
- The GitHub CI hook will test your changes.
- Once ready, the PR `checks` box will be updated with the test results along with a link to the full results on Jenkins.
- Investigate and fix failures caused by the pull request.
- Fixes can simply be pushed to the same branch from which you opened your pull request.
- Jenkins will automatically re-test when new commits are pushed, if an existing commit is amended, if the branch is rebased or if the pull request is closed or reopened.
- Despite our efforts, DistributedLog may have flaky tests at any given point, which may cause a build to fail. Unfortunately, it's not currently possible to restart the build by issuing a command. A workaround, as stated above, is to close and reopen the PR. If the failure is unrelated to your pull request and you have been able to run the tests locally successfully, please mention it in the pull request.
- Fixes can simply be pushed to the same branch from which you opened your pull request.
...