Thanks for being willing to contribute!
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
- Fork and clone the repo
yarn
to setup your clone of the projectyarn run validate
to validate your clone of the project- Create a branch for your PR
Tip: Keep your
master
branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:git remote add upstream https://github.com/akameco/s2s.git git fetch upstream git branch --set-upstream-to=upstream/master master
This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local
master
branch to use the upstream master branch whenever you rungit pull
. Then you can make all of your pull request branches based on thismaster
branch. Whenever you want to update your version ofmaster
, do a regulargit pull
.
yarn run watch
This project follows the all contributors specification.
To add yourself to the table of contributors on the README.md
, please use the
automated script as part of your PR:
yarn run add-contributors
Follow the prompt and commit .all-contributorsrc
and README.md
in the PR.
If you've already added yourself to the list and are making
a new type of contribution, you can run it again and select the added
contribution type.
Please make sure to run the tests before you commit your changes. You can run
npm run test:update
which will update any snapshots that need updating.
Make sure to include those changes (if they exist) in your commit.
Please checkout the the open issues
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!