Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 1.42 KB

CONTRIBUTING

All pull requests are welcome, there are just a few guidelines you need to follow.

When contributing to this repository, please first discuss the change by creating a new issue or by replying to an existing one.

GETTING STARTED

MAKING CHANGES

  • Create branch topic for the work you will do, this is where you want to base your work.
  • This is usually the main branch.
  • To quickly create a topic branch based on main, run
    git checkout -b u/username/topic main
    • Make sure to substitute your own name and topic in this command *
  • Once you have a branch, make your changes and commit them to the local branch.
  • All submissions require a review and pull requests are how those happen. Consult GitHub Help for more information on pull requests.

SUBMITTING CHANGES

  • Push your changes to a topic branch in your fork of the repository.

PUSH TO YOUR FORK AND SUBMIT A PULL REQUEST

At this point you're waiting on the code/changes to be reviewed.