mirrors/bookwyrm
1
0
Fork 1
mirror of https://github.com/bookwyrm-social/bookwyrm.git synced 2024-11-25 11:01:12 +00:00
Code Issues Projects Releases Wiki Activity
bookwyrm/.github/pull_request_template.md

69 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +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.
2024-06-08 15:31:34 +00:00
Thanks for contributing! This template has some checkboxes that help keep track of what changes go into a release.
add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +00:00
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
-->
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.
2024-06-08 15:31:34 +00:00
## Description
add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +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.
2024-06-08 15:31:34 +00:00
Describe what your pull request does here
add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +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.
2024-06-08 15:31:34 +00:00
<!--
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).
add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +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.
2024-06-08 15:31:34 +00:00
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 #
add GitHub templates for PRs and releases This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
2024-04-28 03:30:47 +00:00
## 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)
## 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
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.
2024-06-08 15:31:34 +00:00
<!-- Amazing! Thanks for filling that out. Your PR will need to have passing tests and happy linters before we can merge
Type fix
2024-07-27 15:44:44 +00:00
You will need to check your code with `black`, `pylint`, and `mypy`, or `./bw-dev formatters`
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.
2024-06-08 15:31:34 +00:00
-->
### 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
Reference in a new issue Copy permalink