mirrors/bookwyrm
1
0
Fork 1
mirror of https://github.com/bookwyrm-social/bookwyrm.git synced 2024-06-09 08:49:22 +00:00
Code Issues Projects Releases Wiki Activity
bookwyrm/.github/pull_request_template.md
Hugh Rundle e4035c6da6
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 13:30:47 +10:00

2.5 KiB
Raw Blame History

Are you finished?

Linters

  • I have checked my code with black, pylint, and mypy, or ./bw-dev formatters

Tests

  • 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?

  • Bug Fix
  • Enhancement
  • Plumbing / Internals / Dependencies
  • Refactor

Does this PR change settings or dependencies, or break something?

  • 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

  • Related Issue #
  • Closes #

Documentation

  • 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