-
Notifications
You must be signed in to change notification settings - Fork 258
Making a pull request
Leopold Talirz edited this page Dec 4, 2018
·
10 revisions
- Does your bug fix or feature have a corresponding GitHub issue? If not, open one!
- Is it a bug fix or a feature?
-
bug fix: goes into the latest release branch, e.g.
release_v0.12.3. -
feature: goes into the
developbranch
-
bug fix: goes into the latest release branch, e.g.
- Check out the correct branch locally:
git checkout release_vX.Y.Z
git pull origin release_vX.Y.Z
- Create a new issue branch using the following naming convention:
git checkout -b issue_1234_short_description_of_issue
- Add your changes and commit them to your issue branch.
- If it's a bug, add a test
- If it's a new feature, add tests
- When you're ready, push your local branch to your fork
git push fork issue_1234_short_description_of_issue
- Create a pull request on GitHub from the branch in your fork to the correct branch of
aiidateam/aiida_core- Use the PR title to describe its contents (bad: "Fix issue 1234", good: "quicksetup now works without sudo")
- Mention the issue number in the description of the PR
- Open your pull request only once you believe your changes are ready to be merged.
If you keep pushing changes to an open PR, developers are flooded with emails. - All PRs undergo continuous integration testing using Travis. If your PR fails a test (no worries), you are expected to fix them before a developer reviews your PR.