Skip to content

Create CONTRIBUTING.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RachL wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create CONTRIBUTING.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing
We love pull requests from everyone. Any contribution is valuable!

If you have some time and are interested in working on some issues please have a look at the list of issues and browse the ones labelled good-first-issues. Feel free to propose your own issues as well!

## Making a change

Make your changes to the codebase. We recommend using TDD. Add a test, make changes and get the test suite back to green.

Once the tests are passing you can commit your changes.

git add .
git commit -m "Add a concise commit message describing your change here"

Push your changes to a branch on your fork:

git push origin branch-name-here

## Submitting a Pull Request

Use the GitHub UI to submit a new pull request against upstream/master.

Please ensure that you:
* Write tests
* Make sure the whole test suite is passing
* Keep your PR small, with a single focus
* Maintain a clean commit history
* Use a style consistent with the rest of the codebase
* Before submitting, rebase on the current master branch