diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6dac46169..cdb7026e2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,37 @@ -- [ ] Pull request is based on the default branch (`3.x` at this time) -- [ ] Pull request includes tests for any new/updated operations/facts -- [ ] Pull request includes documentation for any new/updated operations/facts -- [ ] Tests pass (see `scripts/dev-test.sh`) -- [ ] Type checking & code style passes (see `scripts/dev-lint.sh`) +## Summary + + + +## Related issues + + + +## Test plan + + + +## Labels + + + +## Checklist + +- [ ] Based on `3.x` +- [ ] Focused on a single change (no unrelated refactors / churn / multiple features in 1 PR) +- [ ] Tests added or updated for new/changed operations, facts, connectors +- [ ] Docs added or updated for user-facing changes +- [ ] `scripts/dev-test.sh` passes +- [ ] `scripts/dev-lint.sh` passes diff --git a/docs/contributing.md b/docs/contributing.md index af5c15971..0f6d852cd 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -50,6 +50,15 @@ scripts/dev-format.sh Please try to use consistent commit messages, look at the [recent history](https://github.com/pyinfra-dev/pyinfra/commits/) for examples. PRs that follow this will be rebased, PRs that do not will be squashed. +### Pull Request Labels + +PRs feed into an auto-generated changelog via [Release Drafter](https://github.com/pyinfra-dev/pyinfra/blob/3.x/.github/release-drafter.yml). Please apply: + ++ one area label: `api`, `core`, `operations`, `facts`, `connectors`, `cli`, `docs`, `meta`, `tests`, or `dependencies` ++ one version-bump label: `breaking` (major), `enhancement` or `feature` (minor), `bugfix` or `fix` (patch) + +Maintainers will adjust labels on merge if needed. + ### Tests GitHub will run all the test suites as part of any pull requests. There's a handy script that runs the unit tests: