Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,37 @@
<!--
🎉 Thank you for taking the time to contribute to pyinfra! 🎉

Please provide a short description of the proposed change and here's a handy checklist of things
to make PRs quicker to review and merge.
See the contributing guide: https://docs.pyinfra.com/en/latest/contributing.html

Note that we will not merge new connectors, but instead welcome PRs that link to thid party
connector packages.
New connectors are shipped as separate packages, not merged here —
docs PRs linking to them are very welcome.
-->

- [ ] 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

<!-- What changed and why. A sentence or two. -->

## Related issues

<!-- "Closes #1234" / "Refs #5678" -->

## Test plan

<!-- How did you verify this? Commands run, scenarios exercised. -->

## Labels

<!--
Pick one area label: api · core · operations · facts · connectors · cli · docs · meta · tests · dependencies
Pick one version-bump label: breaking · enhancement · feature · bugfix · fix
(See .github/release-drafter.yml — labels drive the changelog bucket.)
-->

## 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
9 changes: 9 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading