mirror of
https://github.com/bookwyrm-social/bookwyrm.git
synced 2024-11-28 20:41:46 +00:00
79 lines
2.5 KiB
Markdown
79 lines
2.5 KiB
Markdown
|
<!--
|
||
|
|
Thanks for contributing!
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
- [x] I have checked the box
|
||
|
|
|
||
|
|
You can find more information and tips for BookWyrm contributors at https://docs.joinbookwyrm.com/contributing.html
|
||
|
|
-->
|
||
|
|
|
||
|
|
## Are you finished?
|
||
|
|
|
||
|
|
### Linters
|
||
|
|
<!--
|
||
|
|
Please run linters on your code before submitting your PR.
|
||
|
|
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 -->
|
||
|
|
|
||
|
|
- [ ] 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
|
||
|
|
|
||
|
|
## What type of Pull Request is this?
|
||
|
|
<!-- Check all that apply -->
|
||
|
|
|
||
|
|
- [ ] Bug Fix
|
||
|
|
- [ ] Enhancement
|
||
|
|
- [ ] Plumbing / Internals / Dependencies
|
||
|
|
- [ ] Refactor
|
||
|
|
|
||
|
|
## Does this PR change settings or dependencies, or break something?
|
||
|
|
<!-- Check all that apply -->
|
||
|
|
|
||
|
|
- [ ] This PR changes or adds default settings, configuration, or .env values
|
||
|
|
- [ ] This PR changes or adds dependencies
|
||
|
|
- [ ] This PR introduces other breaking changes
|
||
|
|
|
||
|
|
### 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 for users, admins, and developers is an important way to keep the BookWyrm community welcoming and make Bookwyrm easy to use.
|
||
|
|
Our documentation is maintained in a separate repository at https://github.com/bookwyrm-social/documentation
|
||
|
|
-->
|
||
|
|
|
||
|
|
<!-- Check all that apply -->
|
||
|
|
|
||
|
|
- [ ] New or amended documentation will be required if this PR is merged
|
||
|
|
- [ ] 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
|
||
|
|
|