CONTRIBUTING.md (1707B)
1 ## Contributing 2 3 [fork]: https://github.com/iostpa/reviewbot/fork 4 [pr]: https://github.com/iostpa/reviewbot/compare 5 [style]: https://standardjs.com/rules.html 6 7 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. 8 9 Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE). 10 11 ## Submitting a pull request 12 13 1. [Fork][fork] and clone the repository 14 1. Install the dependencies: `bun install` 15 1. Make sure the linter passes on your machine: `bun run lint`. If you want it to fix most/all errors then use `bun run lint --fix`. 16 1. Create a new branch: `git checkout -b my-branch-name` 17 1. Make your change, and make sure the linter is still happy 18 1. Push to your fork and [submit a pull request][pr] 19 1. Pat your self on the back and wait for your pull request to be reviewed and merged. 20 21 Here are a few things you can do that will increase the likelihood of your pull request being accepted: 22 23 - Follow the [style guide][style]. 24 - 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. 25 - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). 26 - Follow the [Semantic Versioning](https://semver.org/) rules. 27 28 ## Resources 29 30 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) 31 - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) 32 - [GitHub Help](https://help.github.com)