| 1 | # How to contribute
|
| 2 |
|
| 3 | ## Setup
|
| 4 |
|
| 5 | ```sh
|
| 6 | git clone https://github.com/danger/danger-js.git
|
| 7 | cd danger-js
|
| 8 |
|
| 9 | # if you don't have yarn installed
|
| 10 | npm install -g yarn
|
| 11 |
|
| 12 | yarn install
|
| 13 | ```
|
| 14 |
|
| 15 | You can then verify your install by running the tests, and the linters:
|
| 16 |
|
| 17 | ```sh
|
| 18 | yarn test
|
| 19 | yarn lint
|
| 20 | ```
|
| 21 |
|
| 22 | The fixers for both tslint and prettier will be applied when you commit, and on a push your code will be verified that
|
| 23 | it compiles.
|
| 24 |
|
| 25 | ### How does Danger JS work?
|
| 26 |
|
| 27 | Check the [architecture doc](https://github.com/danger/danger-js/blob/main/docs/architecture.md).
|
| 28 |
|
| 29 | ### What is the TODO?
|
| 30 |
|
| 31 | Check the issues, I try and keep my short term perspective there. Long term is in the [VISION.md](VISION.md).
|
| 32 |
|
| 33 | ### Releasing a new version of Danger
|
| 34 |
|
| 35 | Following [this commit](https://github.com/danger/danger-js/commit/a26ac3b3bd4f002acd37f6a363c8e74c9d5039ab) as a model:
|
| 36 |
|
| 37 | - Checkout the `main` branch. Ensure your working tree is clean, and make sure you have the latest changes by running
|
| 38 | `git pull`.
|
| 39 | - Update `package.json` with the new version - for the sake of this example, the new version is **0.21.0**.
|
| 40 | - Modify `changelog.md`, adding a new `### 0.21.0` heading under the `### Main` heading at the top of the file.
|
| 41 | - Commit both changes with the commit message **Version bump**.
|
| 42 | - Tag this commit - `git tag 0.21.0`.
|
| 43 | - Push the commit and tag to master - `git push origin main --follow-tags`. GitHub Actions will build the tagged commit
|
| 44 | and publish that tagged version to NPM.
|
| 45 |
|
| 46 | :ship:
|
| 47 |
|
| 48 | ## License, Contributor's Guidelines and Code of Conduct
|
| 49 |
|
| 50 | We try to keep as much discussion as possible in GitHub issues, but also have a pretty inactive Slack --- if you'd like
|
| 51 | an invite, ping [@Orta](https://twitter.com/orta/) a DM on Twitter with your email. It's mostly interesting if you want
|
| 52 | to stay on top of Danger without all the emails from GitHub.
|
| 53 |
|
| 54 | > This project is open source under the MIT license, which means you have full access to the source code and can modify
|
| 55 | > it to fit your own needs.
|
| 56 | >
|
| 57 | > This project subscribes to the [Moya Contributors Guidelines](https://github.com/Moya/contributors) which TLDR: means
|
| 58 | > we give out push access easily and often.
|
| 59 | >
|
| 60 | > Contributors subscribe to the [Contributor Code of Conduct](http://contributor-covenant.org/version/1/3/0/) based on
|
| 61 | > the [Contributor Covenant](http://contributor-covenant.org) version 1.3.0.
|