Skip to content

Commit

Permalink
ci: pr title linter and updates contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
nyoungstudios committed Oct 9, 2022
1 parent 833f989 commit 5efbe53
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/pr_title_linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: PR Title Linter

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

jobs:
main:
name: Conventional Commits
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
types: |
feat
fix
build
ci
docs
style
refactor
perf
test
chore
scopes: |
core
functions
configs
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ And if you need to test out your code on macOS, I recommend creating a virtual m
Now you are ready to open your pull request. For the PR title, please try to follow the format from the [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0):

```bash
<type>: description
<type>(optional scope): description
```

While we do not have an automated changelog yet, I still think it is a good standard to go by. Also, this project is not really large enough to have scopes, so you can leave that part out, but for the `type`, feel free to use any of these options:
While we do not have an automated changelog yet, I still think it is a good standard to go by. For the `type`, feel free to use any of these options:

- `feat`: for adding a feature
- `fix`: for resolving a bug
Expand All @@ -75,4 +75,10 @@ While we do not have an automated changelog yet, I still think it is a good stan
- `test`: for testing
- `chore`: for anything else

And for the `scope`, please use these options if relevant (otherwise, please omit the scope):

- `core`: changes relating to the main Dart program and `install.sh` script. Also, its related tests and documentation.
- `functions`: changes to the functions folder
- `configs`: adding/modifying a config in the configs folder

In your PR description, please include what you changed, any testing you did, and reference any issue that it resolves. See [this GitHub guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) on how to link a pull request to an issue.

0 comments on commit 5efbe53

Please sign in to comment.