Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

43 lines (34 loc) · 1.29 KB
Raw

Contributing

For any changes, please create a feature branch and open a PR for it when you feel it's ready to merge. Even if there's no real disagreement about a PR, at least one other person on the team needs to look over a PR before merging. The purpose of this review requirement is to ensure shared knowledge of the app and its changes and to take advantage of the benefits of working together changes without any single person being a bottleneck to making progress.

Steps

  1. Fork this repository.

  2. Clone the repository by running this command:

    $ git clone https://github.com/YOUR-GITHUB-USERNAME/playtime.git

  3. Add a remote upstream that points to the original Playtime repository:

    $ git remote add upstream https://github.com/rubyforgood/playtime.git

  4. Create a new branch to make changes. The branch name should be relevant to your change (ex. rubocop or setup-mailers). You can create a new branch with:

    $ git checkout -b BRANCH-NAME

  5. Make your modification, make sure the tests pass, and commit the changes locally:

    $ bundle exec rake
$ git commit

  6. Push your new branch to GitHub:

    $ git push origin BRANCH-NAME

  7. Open a pull request on GitHub.