Pull Request Checklist - apache/helix GitHub Wiki

Before you submit a pull request from your forked repo make sure that it meets these guidelines:

PR Description

• Find an existing helix issue or create a new helix issue.
• Mention the issue number in the PR description.
• If adding new functionality include unit tests, integration tests, or both.
• Include the result of mvn test command in your PR's description. See 📝 Pull Request Testing for details.
• Make sure that your PR conforms to the 📝 Helix PR Template

Branch

• update your fork of helix
• rebase your feature branch with git rebase -i upstream/master
• resolve all conflicts
• git push --force from your feature branch to cleanly update your PR

Docs

• Add an Apache License header to all new files
• If the pull request adds functionality, please add a new helix wiki page that details the motivation for and use of the new feature.

After Creating PR

• address reviewer comments and feedback.
• Leave a final Github comment (example) on the PR in this format:

This PR is ready to be merged, approved by @reviewer  
Final commit message:
## <Final Commit Subject> (#<IssueNumber>)
<Final Commit Body>

• git commit --allow-empty -m "<Your PR Title>" to create one final commit message that Github will use when it squashes your branch to create one squashed commit to be merged into master.

See also the helix 📝 PR Merge Steps

Tip

Put an "x" between brackets to mark the box checked in the markdown (e.g. [ ] -> [x])