Skip to content

Commit

Permalink
docs(#2264): adopt Conventional Commits (#2273)
Browse files Browse the repository at this point in the history
| Q             | A           |
|---------------|-------------|
| Bug fix?      | no          |
| New feature?  | no          |
| Deprecations? | no          |
| Issues        | Close #2264 |

* Adds a GitHub Actions workflow (based on
[amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request))
validating PR titles for compliance with the [Conventional
Commits](https://www.conventionalcommits.org/) specification.

---------

Co-authored-by: Djordy Koert <[email protected]>
Co-authored-by: djordy <[email protected]>
  • Loading branch information
3 people committed Jun 12, 2024
1 parent 76bddcb commit 599283f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/pr-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: GitHub PR Lint

on:
pull_request_target:
types:
- opened
- edited
- reopened
- synchronize

jobs:
semantic-pr:
name: Validate semantic PR title
runs-on: ubuntu-latest

steps:
- name: Semantic PR title
uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
subjectPattern: ^(?![A-Z]).+$ # This pattern ensures the subject doesn't start with an uppercase character.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,14 @@ You SHOULD write (or update) documentation.
You SHOULD write
[commit messages that make sense](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

You MUST [rebase your branch](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) before submitting your Pull Request.
### Pull requests

While creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you
are creating it.
You MUST [rebase your branch](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) before submitting your pull request.

You MUST use a pull request title compliant with the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

You MUST write a meaningful description which gives the context and/or explains why you
are creating the pull request.

You SHOULD resolve review comments instead of commenting.
<sub>Once you've done the work, resolve the conversation by selecting the Resolve conversation button in the PR overview. Avoid posting comments like "I've done the work", or "Done".</sub>

0 comments on commit 599283f

Please sign in to comment.