Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benhodgson87 authored Jul 12, 2024
1 parent 006663e commit 0157a7b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# conventional-pull-request-action

A Github Action that enforces the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/#specification) on pull request titles, whilst allowing for linting of scopes to be applied, for example to enforce the use of ticket numbers from issue trackers and project management tools. Although common opinion, and the spec, direct against doing this, it can be valuable in generating rich release notes for projects/organisations who do not find value in noun-based scopes.
A Github Action that enforces the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/#specification) on pull request titles, whilst allowing for linting of scopes to be applied, for example to enforce the use of ticket numbers from issue trackers and project management tools. Although the spec generally directs against doing this, it can be valuable in generating rich release notes for projects/organisations who do not find value in noun-based scopes.

Forked from, and heavily based on, Conde Nast's [conventional-pull-request-action](https://github.com/CondeNast/conventional-pull-request-action).

Expand Down

0 comments on commit 0157a7b

Please sign in to comment.