Skip to content

Pull Requests

kstola2 edited this page Nov 6, 2019 · 13 revisions

Base Branch

Pull requests should always have their base branch set to the dev branch, unless stated otherwise in the issue.

Title

The name of the feature being added.

Comment

Always write "Issue #[the relevant issue number]" at the top with the number of the issue this Pull Request is pertaining to.

A brief description of what the changes are or any problems the reviewer needs to be aware of should also be included.

Project

Make sure to select which project the pull request is relevant to.

Milestone

If the issue this pull request pertains to is part of a Milestone, select the milestone as well.

Request a Reviewer

Request a CO (Code Owner) to review your PR. Check out https://github.com/orgs/SIGBlockchain/people

Travis

Travis CI is a tool we use for continuous integration. Travis will make a copy of your pull request with all your changes, run every test in Aurum, and report any failures.

Resolving merge conflicts

If you don't have experience resolving merge conflicts, I suggest checking out this documentation

Merging

Once the pull request is marked as approved you can go ahead and merge it. Make sure you select "Squash and Merge". Then select "Delete branch"

Closing out the issue

Upon successfully merging, go to the issue relevant to the pull request and comment "Completed". Then hit Close and comment.

Clone this wiki locally