This is the configuration repo for Peril on the Artsy org. There is a settings file and org-wide dangerfiles which are inside the org folder.
Here's some links to the key things
Peril is Danger running on a web-server, this repo is the configuration for that, currently the dangerfiles in org run on every issue and pull request for all our repos.
git clone https://github.com/artsy/artsy-danger.git
yarn install
code .
You will need node and yarn installed beforehand. You can get them both by running brew install yarn
. This will give you auto-completion and types for Danger/Peril mainly.
Any PR that adds a new rule at org-wide level to every repo should be treated as an RFC. Please make an issue with this template:
Title: "RFC: Add a Markdown Spell Checker to all Markdown docs in PR"
## Proposal:
Apply a spell checker to every markdown document that appears in a PR.
## Reasoning
We want to have polished documents, both internally and externally. Having a spellcheck
happening without any effort on a developers part means that we'll get a second look at
any documentation improvements on any repo.
## Exceptions:
This won't be perfect, but it is better to get something working than to not have it at all.
I added the ability to ignore files: so CHANGELOGs which tend to be really jargon heavy will
be avoided in every repo.
Other than that, we can continue to build up a global list of words to ignore.
Peril will post a message in the #dev slack channel for everyone to see when you include "RFC:"
in your issue title.