diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6b652dacf..f1b35f56f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,77 +10,78 @@ If there is a field which you are unsure about, enter the edit mode of this desc ## 1. Description / Summary -_Add a summary of the changes in this PR and the related issue._ +**Add a summary here**: What does this PR add/change and why? ## 2. Jira task / GitHub issue -_Link to the github issue or add the Jira task ID here._ +**Is this a GitHub issue?** --> Add the link to the github issue -## 3. Type of change +**Is this from a Jira task?** --> If your branch does not contain info regarding the Jira task ID, put it here. -What _type of change(s)_ does the PR contain? +## 3. Type of change - Add label -**Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.** +**What _type of change(s)_ does the PR contain? For an explanation of the different options below, enter edit mode of this PR description template.** -- [ ] New feature - - [ ] Breaking: _Why / How? Add info here._ - - [ ] Non-breaking -- [ ] Database change: _Remember the to include a new migration version, **or** explain here why it's not needed._ -- [ ] Bug fix -- [ ] Security Alert fix - - [ ] Package update - - [ ] Major version update -- [ ] Documentation -- [ ] Workflow -- [ ] Tests **only** +_If you do not want this change to be included in release notes, add the label `skip-changelog`._ + +- New feature + - Breaking --> label: `breaking` + - Non-breaking --> label: `feature` +- Database change --> label: `feature` or none at all. + _Remember the to include a new migration version, **or** explain here why it's not needed._ +- Bug fix --> label: `bug` +- Security Alert fix + - Package update --> label: `dependency` + - Major version update +- Documentation --> label can be skipped, will be included in "other changes" +- Workflow --> label: `skip-changelog` +- Tests **only** --> label: `skip-changelog` ## 4. Additional information -- [ ] [Sprintlog](../SPRINTLOG.md) -- [ ] Blocking PRs - - [ ] Merged -- [ ] PR to `master` branch: \_If checked, read [the release instructions](../doc/procedures/new_release.md) +- [ ] I have added an entry to the [Sprintlog](../SPRINTLOG.md) +- [ ] This is a PR to the `master` branch: _If checked, read [the release instructions](../doc/procedures/new_release.md)_ - [ ] I have followed steps 1-8. ## 5. Actions / Scans -_Check the boxes when the specified checks have passed._ - -**For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the [PR template](../.github/pull_request_template.md).** +**Make sure that the following checks/actions have passed.** -- [ ] **Black** +- **Black** -- [ ] **Prettier** +- **Prettier** -- [ ] **Yamllint** +- **Yamllint** -- [ ] **Tests** +- **Tests** -- [ ] **CodeQL** +- **CodeQL** -- [ ] **Trivy** +- **Trivy** -- [ ] **Snyk** +- **Snyk** + +If an action does not pass and you need help with how to solve it, enter edit mode of this PR template or go to the [PR template](../.github/pull_request_template.md). \ No newline at end of file diff --git a/.github/release.yml b/.github/release.yml index 3aa5ebf47..6e42efb81 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -15,6 +15,9 @@ changelog: - title: ⛓️‍💥 Breaking Changes labels: - breaking + - title: 🛡️ Dependencies + labels: + - dependency - title: Other Changes labels: - "*" # Catch-all for pull requests that didn't match any of the previous categories