Skip to content

Commit

Permalink
docs(commits): call out scope for rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcy Sutton committed Sep 11, 2017
1 parent f3670fb commit 79643d8
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/code-submission-guidelines.md
Expand Up @@ -33,7 +33,7 @@ that includes a type, a scope and a subject. Here's a sample of the format:
### Here's an example:

```sh
perf(color-contrast): improve speed of color contrast rules
perf(rule): improve speed of color contrast rules

Use async process to compare elements without UI lockup

Expand Down Expand Up @@ -63,11 +63,12 @@ generation
#### Scope

The scope specifies the place of the commit change in the codebase along with the type. It could
reference a rule name, a commons file, or anything really. E.g. `perf(color-contrast)` or
`test(p-as-heading)`.
reference a rule, a commons file, or anything really. E.g. `feat(rule)` or
`test(commons/aria)`. It would help us call to out rule changes in our changelog with `rule` used as the scope.

If the scope is too broad to summarize, use the type only and leave off the parentheses. E.g.
`type: some subject`
`type: some subject`. Keep in mind that a long scope often pushes your commit message over 100 characters.
Brevity is helpful for everyone!


#### Subject
Expand Down

0 comments on commit 79643d8

Please sign in to comment.