Skip to content
This repository has been archived by the owner on Jan 4, 2021. It is now read-only.

Latest commit

 

History

History
115 lines (95 loc) · 2.84 KB

README.md

File metadata and controls

115 lines (95 loc) · 2.84 KB

wearereasonablepeople Peril Settings

Settings and danger rules for the wearereasonablepeople organization.

WARN: Update README.hbs instead of this file, it is generated with npm run readme

Rules

This is the list of current rules in this repository:

lineLength
Fails when any commit except Merge commits have a line in their body that exceeds 100 characters
typePrefix
Warns when a commit does not have a known type prefix:
  • feat:
  • fix:
  • test:
  • ci:
  • chore:
  • docs:
  • refactor:
  • style:
  • perf:
  • revert:
packageJsonChange
Warns when `package.json` changes but `package-lock.json` doesn't
packageLockChange
Warns when `package-lock.json` changes but `package.json` doesn't
noReviewers
Fails when there are no requested reviewers
authorPrefix
Warns when the PR's branch doesn't start with the opener's github handle or a substring of it
assignee
Warns when the PR has no assignee
missingMotivationHeader
Warns when there's no `# Motivation` header in the PR markdown body
missingChangesHeader
Warns when there's no `# Changes` header in the PR markdown body

Danger

Danger JS runs a set of rules against PRs to enforce conventions around code review.

Running locally

In order to run the rules on your machine against an existing PR, do the following:

  1. Go to your github settings and generate a token with repo access
  2. Add it to the DANGER_GITHUB_API_TOKEN env var:
export DANGER_GITHUB_API_TOKEN='your-token-here'
  1. npx danger pr {https://github.com/wearereasonablepeople/{repo}/pull/{pr number}

Peril

Peril is the hosted version of Danger and our preferred way of running org-wide checks.

Peril allows for some interesting things:

  • Centralization of danger rules
  • Single point of management for the github bot's token.
  • Repo to to put RFCs

Updating Danger JS rules

See the contribution guide

Links