Skip to content

Commit d268751

Browse files
authored
ci: PR template, improved release-drafter (#728)
1 parent f597ae7 commit d268751

File tree

3 files changed

+44
-10
lines changed

3 files changed

+44
-10
lines changed

.github/pull_request_template.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
# Thanks for contributing a pull request!
3+
## Please make sure you see our contribution guidelines: https://github.com/pydata/sparse/blob/main/docs/contributing.md
4+
5+
Your PR title should start with any of these abbreviatons: `build`, `chore`, `ci`, `depr`, `docs`, `feat`, `fix`, `perf`, `refactor`, `release`, `test`. Add a `!`at the end, if it is a breaking change.
6+
-->
7+
8+
## What type of PR is this? (check all applicable)
9+
10+
- [ ] 💾 Refactor
11+
- [ ] 🪄 Feature
12+
- [ ] 🐞 Bug Fix
13+
- [ ] 🔧 Optimization
14+
- [ ] 📚 Documentation
15+
- [ ] 🧪 Test
16+
- [ ] 🛠️ Other
17+
18+
## Related issues
19+
20+
- Related issue #
21+
- Closes #
22+
23+
## Checklist
24+
25+
- [ ] Code follows style guide
26+
- [ ] Tests added
27+
- [ ] Documented the changes
28+
29+
***
30+
31+
## Please explain your changes below.

.github/release-drafter.yml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,31 @@ autolabeler:
3939
title:
4040
- '/^\[pre-commit.ci\]/'
4141
categories:
42-
- title: Highlights
42+
- title: 📣 Highlights
4343
labels: highlight
44-
- title: Breaking changes
44+
- title: 🧨 Breaking changes
4545
labels:
4646
- breaking
4747
- breaking python
48-
- title: Deprecations
48+
- title: 🚧 Deprecations
4949
labels: deprecation
50-
- title: Performance improvements
50+
- title: 🪄 Performance improvements
5151
labels: performance
52-
- title: Enhancements
52+
- title: 🎊 Enhancements
5353
labels: enhancement
54-
- title: Bug fixes
54+
- title: 🐞 Bug fixes
5555
labels: fix
56-
- title: Documentation
56+
- title: 📚 Documentation
5757
labels: documentation
58-
- title: Build system
58+
- title: 🧰 Build system
5959
labels: build
60-
- title: Other improvements
60+
- title: 🔧 Other improvements
6161
labels: internal
6262

6363
template: |
6464
## Changes
6565
6666
$CHANGES
67+
68+
Thank you to all our contributors for making this release possible!
69+
$CONTRIBUTORS

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Please adhere to the following guidelines:
5353

5454
1. Start your pull request title with a [conventional commit](https://www.conventionalcommits.org/) tag. This helps us add your contribution to the right section of the changelog. We use "Type" from the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type).<br>
5555
TLDR:<br>
56-
The PR title should start with any of this abbreviatons: `build`, `chore`, `ci`, `depr`,
56+
The PR title should start with any of these abbreviatons: `build`, `chore`, `ci`, `depr`,
5757
`docs`, `feat`, `fix`, `perf`, `refactor`, `release`, `test`. Add a `!`at the end, if it is a breaking change. For example `refactor!`.
5858
2. This text will end up in the changelog.
5959
3. Please follow the instructions in the pull request form and submit.

0 commit comments

Comments
 (0)