Skip to content
This repository has been archived by the owner on Mar 14, 2023. It is now read-only.

Commit

Permalink
docs: explain rule configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
darioblanco committed May 23, 2022
1 parent 1cad6d1 commit 0ec9926
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# @parcellab/danger-plugin

Set of Danger rules used to check personal PRs.
This repository serves as an example to set up company specific rules for PR checking.
Set of Danger rules used to check PRs in JavaScript/TypeScript codebases.

This plugin allows configuration for the following events:

- Conventional commits format
- Commit scopes (useful for monorepos)
- PR title length
- PR title scope (useful for monorepos)
- PR relation to JIRA issue
- Maximum number of commits in the PR
- Maximum number of lines in the PR
- Maximum number of changed files in the PR

## Usage

Expand Down

0 comments on commit 0ec9926

Please sign in to comment.