status-im
/
status-github-bot
mirror of https://github.com/status-im/status-github-bot.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
status-github-bot/CONTRIBUTING.md

1.8 KiB
Raw Permalink Blame History

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: yarn install
  3. Make sure the tests pass on your machine: yarn test, note: these tests also apply the linter, so no need to lint seperately
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. Push to your fork and submit a pull request
  7. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide which is using standard. Any linting errors should be shown when running yarn test
  • Write and update tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.

Resources