generated from norlab-ulaval/template-norlab-project
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added semantic-release support and pull request template
- Loading branch information
1 parent
0a9c0f3
commit d582f3c
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Description | ||
### Summary: | ||
|
||
|
||
|
||
|
||
|
||
|
||
### Changes and type of changes (quick overview): | ||
|
||
- | ||
- | ||
- | ||
|
||
|
||
--- | ||
|
||
# Checklist: | ||
|
||
### Code related | ||
- [ ] I have made corresponding changes to the documentation (i.e.: function/class, script header, README.md) | ||
- [ ] I have commented hard-to-understand code | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] All tests pass locally with my changes (Check `tests/README.md` for local testing procedure) | ||
- [ ] My commit messages follow the [conventional commits](https://www.conventionalcommits.org) specification. See `commit_msg_reference.md` in the repository root for details | ||
|
||
### PR creation related | ||
- [ ] My pull request `base ref` branch is set to the `dev` branch (the _build-system_ won't be triggered otherwise) | ||
- [ ] My pull request branch is up-to-date with the `dev` branch (the _build-system_ will reject it otherwise) | ||
|
||
### PR description related | ||
- [ ] I have included a quick summary of the changes | ||
- [ ] I have indicated the related issue's id with `# <issue-id>` if changes are of type `fix` | ||
|
||
## Note for repository admins | ||
### Release PR related | ||
- Only repository admins have the privilege to `push/merge` on the default branch (ie: `main`) and the `release` branch. | ||
- Keep PR in `draft` mode until all the release reviewers are ready to push the release. | ||
- Once a PR from `release` -> `main` branch is created (not in draft mode), it triggers the _build-system_ test | ||
- On merge to the `main` branch, it triggers the _semantic-release automation_ |