Skip to content

Commit bfae135

Browse files
committed
docs: improve contributing doc, add GitHub PR template
1 parent 3ea5f5e commit bfae135

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!--
2+
🎉 Thank you for taking the time to contribute to pyinfra! 🎉
3+
4+
Please provide a short description of the proposed change and here's a handy checklist of things
5+
to make PRs quicker to review and merge.
6+
7+
Note that we will not merge new connectors, but instead welcome PRs that link to thid party
8+
connector packages.
9+
-->
10+
11+
- [ ] Pull request is based on the default branch (`3.x` at this time)
12+
- [ ] Pull request includes tests for any new/updated operations/facts
13+
- [ ] Pull request includes documentation for any new/updated operations/facts
14+
- [ ] Tests pass (see `scripts/dev-test.sh`)
15+
- [ ] Type checking & code style passes (see `scripts/dev-lint.sh`)

docs/contributing.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Third party pull requests help expand pyinfra's functionality and are essential
88

99
+ [How to write operations](api/operations)
1010
+ [How to write facts](api/facts)
11-
+ [How to write connectors](api/connectors)
12-
+ [API reference](api/reference)
11+
+ [How to write connectors](api/connectors) - note that new connectors **will not be merged to pyinfra**, instead they should be provided as a separate installable package. PR's that link to these packages in the docs very welcome.
12+
+ Low level [API reference](api/reference) - this is pyinfra's internal APIs and does not come with the same compatibility guarantees as facts & operations - ie expect breaking changes on non-major versions.
1313

1414
## Branches
1515

@@ -38,6 +38,10 @@ Code style is enforced via Black, isort and flake8. Types are checked with mypy
3838
scripts/dev-lint.sh
3939
```
4040

41+
### Commit Messages
42+
43+
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.
44+
4145
### Tests
4246

4347
GitHub will run all the test suites as part of any pull requests. There's a handy script that runs the unit tests:

0 commit comments

Comments
 (0)