mirror of
https://github.com/bookwyrm-social/bookwyrm.git
synced 2024-11-22 17:41:08 +00:00
Reorganizes PR template a bit
I found the template a little overwhelming, so this is an attempt to make it a little more navigable and slightly less effortful.
This commit is contained in:
parent
3545a1c3b6
commit
2e675474a9
1 changed files with 24 additions and 34 deletions
58
.github/pull_request_template.md
vendored
58
.github/pull_request_template.md
vendored
|
@ -1,10 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
Thanks for contributing!
|
Thanks for contributing! This template has some checkboxes that help keep track of what changes go into a release.
|
||||||
|
|
||||||
Please ensure the name of your PR is written in imperative present tense. For example:
|
|
||||||
|
|
||||||
- "fix color contrast on submit buttons"
|
|
||||||
- "add 'favourite food' value to Author model"
|
|
||||||
|
|
||||||
To check (tick) a list item, replace the space between square brackets with an x, like this:
|
To check (tick) a list item, replace the space between square brackets with an x, like this:
|
||||||
|
|
||||||
|
@ -12,24 +7,23 @@ To check (tick) a list item, replace the space between square brackets with an x
|
||||||
|
|
||||||
You can find more information and tips for BookWyrm contributors at https://docs.joinbookwyrm.com/contributing.html
|
You can find more information and tips for BookWyrm contributors at https://docs.joinbookwyrm.com/contributing.html
|
||||||
-->
|
-->
|
||||||
|
## Description
|
||||||
## Are you finished?
|
|
||||||
|
|
||||||
### Linters
|
|
||||||
<!--
|
<!--
|
||||||
Please run linters on your code before submitting your PR.
|
Describe what your pull request does here
|
||||||
If you miss this step it is likely that the GitHub task runners will fail.
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
- [ ] I have checked my code with `black`, `pylint`, and `mypy`, or `./bw-dev formatters`
|
|
||||||
|
|
||||||
### Tests
|
<!--
|
||||||
<!-- Check one -->
|
For pull requests that relate or close an issue, please include them
|
||||||
|
below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
|
||||||
|
|
||||||
- [ ] My changes do not need new tests
|
For example having the text: "closes #1234" would connect the current pull
|
||||||
- [ ] All tests I have added are passing
|
request to issue 1234. And when we merge the pull request, Github will
|
||||||
- [ ] I have written tests but need help to make them pass
|
automatically close the issue.
|
||||||
- [ ] I have not written tests and need help to write them
|
-->
|
||||||
|
|
||||||
|
- Related Issue #
|
||||||
|
- Closes #
|
||||||
|
|
||||||
## What type of Pull Request is this?
|
## What type of Pull Request is this?
|
||||||
<!-- Check all that apply -->
|
<!-- Check all that apply -->
|
||||||
|
@ -48,21 +42,6 @@ If you miss this step it is likely that the GitHub task runners will fail.
|
||||||
|
|
||||||
### Details of breaking or configuration changes (if any of above checked)
|
### Details of breaking or configuration changes (if any of above checked)
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Describe what your pull request does here.
|
|
||||||
|
|
||||||
For pull requests that relate or close an issue, please include them
|
|
||||||
below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
|
|
||||||
|
|
||||||
For example having the text: "closes #1234" would connect the current pull
|
|
||||||
request to issue 1234. And when we merge the pull request, Github will
|
|
||||||
automatically close the issue.
|
|
||||||
-->
|
|
||||||
|
|
||||||
- Related Issue #
|
|
||||||
- Closes #
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
<!--
|
<!--
|
||||||
|
@ -76,3 +55,14 @@ Our documentation is maintained in a separate repository at https://github.com/b
|
||||||
- [ ] I have created a matching pull request in the Documentation repository
|
- [ ] I have created a matching pull request in the Documentation repository
|
||||||
- [ ] I intend to create a matching pull request in the Documentation repository after this PR is merged
|
- [ ] I intend to create a matching pull request in the Documentation repository after this PR is merged
|
||||||
|
|
||||||
|
<!-- Amazing! Thanks for filling that out. Your PR will need to have passing tests and happy linters before we can merge
|
||||||
|
You will need to check your code with ck`, `pylint`, and `mypy`, or `./bw-dev formatters`
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
<!-- Check one -->
|
||||||
|
|
||||||
|
- [ ] My changes do not need new tests
|
||||||
|
- [ ] All tests I have added are passing
|
||||||
|
- [ ] I have written tests but need help to make them pass
|
||||||
|
- [ ] I have not written tests and need help to write them
|
||||||
|
|
Loading…
Reference in a new issue