| 1 | # Contributing
|
| 2 |
|
| 3 | Thanks for being willing to contribute!
|
| 4 |
|
| 5 | **Working on your first Pull Request?** You can learn how from this _free_
|
| 6 | series [How to Contribute to an Open Source Project on GitHub][egghead]
|
| 7 |
|
| 8 | ## Project setup
|
| 9 |
|
| 10 | 1. Fork and clone the repo
|
| 11 | 2. `npm run setup` to setup and validate your clone of the project
|
| 12 | 3. Create a branch for your PR
|
| 13 |
|
| 14 | > Tip: Keep your `master` branch pointing at the original repository and make
|
| 15 | > pull requests from branches on your fork. To do this, run:
|
| 16 | >
|
| 17 | > ```
|
| 18 | > git remote add upstream https://github.com/huchenme/github-trending-api.git
|
| 19 | > git fetch upstream
|
| 20 | > git branch --set-upstream-to=upstream/master master
|
| 21 | > ```
|
| 22 | >
|
| 23 | > This will add the original repository as a "remote" called "upstream," Then
|
| 24 | > fetch the git information from that remote, then set your local `master`
|
| 25 | > branch to use the upstream master branch whenever you run `git pull`. Then you
|
| 26 | > can make all of your pull request branches based on this `master` branch.
|
| 27 | > Whenever you want to update your version of `master`, do a regular `git pull`.
|
| 28 |
|
| 29 | ## Add yourself as a contributor
|
| 30 |
|
| 31 | This project follows the [all contributors][all-contributors] specification. To
|
| 32 | add yourself to the table of contributors on the `README.md`, please use the
|
| 33 | automated script as part of your PR:
|
| 34 |
|
| 35 | ```console
|
| 36 | npm run contributors:add
|
| 37 | ```
|
| 38 |
|
| 39 | Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. If
|
| 40 | you've already added yourself to the list and are making a new type of
|
| 41 | contribution, you can run it again and select the added contribution type.
|
| 42 |
|
| 43 | ## Help needed
|
| 44 |
|
| 45 | Please checkout the [the open issues][issues]
|
| 46 |
|
| 47 | Also, please watch the repo and respond to questions/bug reports/feature
|
| 48 | requests! Thanks!
|
| 49 |
|
| 50 | [egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
|
| 51 | [all-contributors]: https://github.com/kentcdodds/all-contributors
|
| 52 | [issues]: https://github.com/huchenme/github-trending-api/issues
|