Skip to content

Commit ebbc322

Browse files
authored
Update PR checklist + CONTRIBUTING.md (#1220)
1 parent f01e17b commit ebbc322

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pull-request is published.
1818
`bug`, `feature`, `ui`, `change`, `documentation`, `breaking`, `ci`
1919
as they show up in the changelog.
2020
- [ ] Link this PR to related issues by using [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
21+
- [ ] Add a milestone to the PR for the intended release.
2122
- [ ] Request a review from another developer.
2223

2324
<!--

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Fork the AB repository, create a new branch from the `master` branch, apply your
168168
forked repository and open a pull request from there.
169169
When creating a pull-request, please add a description of what your new changes should accomplish (and if this wasn't a
170170
known problem, _why_ AB needs this).
171-
If it's a larger pull-request, feel free to add screenshots or other useful descriptions to help us understand what
171+
If it's a larger pull-request, feel free to add screenshots/gifs or other useful descriptions to help us understand what
172172
you did.
173173
Next, make sure your pull-request has a sensible title that _users_ can easily understand, this name is shown in the
174174
changelog of the next release.
@@ -185,7 +185,9 @@ This is a [GOOD example of a title](https://github.com/LCA-ActivityBrowser/activ
185185
![image](https://github.com/LCA-ActivityBrowser/activity-browser/assets/34626062/0822a3c8-d01c-4a0c-8cbc-d44c4bbddc02)
186186
- This is a good example because it describes what is changed.
187187

188-
Finally, please make sure you follow the pull-request checklist (you can see this when you open a pull-request.
188+
Finally, please make sure you follow the pull-request checklist (you can see this when you open a pull-request).
189+
If you can't complete certain tasks because you don't have write-access (e.g. adding a label and milestone),
190+
they will be performed by the maintainers.
189191

190192
Upon creating a new pull-request, there are a number of automated tests that will be run.
191193
If the test-runners fail in some way, it is likely that there is an error somewhere in your PR.

0 commit comments

Comments
 (0)