From b382c068812ac75ae5a0898510300063d9b40b32 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Mon, 30 Oct 2023 10:02:38 +0100 Subject: [PATCH] docs --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 60d72424..af3c9ba0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,12 +13,14 @@ But please read our [contribution guide](https://github.com/hynek/structlog/blob If an item doesn't apply to your pull request, **check it anyway** to make it apparent that there's nothing left to do. --> -- [ ] Do **not** open pull requests from your main branch, but **use a branch instead**. There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push that, and open the PR from that. +- [ ] Do **not** open pull requests from your main branch, but **use a branch instead**. + + There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch. This is not a pre-requisite for your your pull request to be accepted, but **you have been warned**. - [ ] Added **tests** for changed code. - The CI fails with less than 100% coverage. -- [ ] **New APIs** are added to [`api.py`](https://github.com/hynek/structlog/blob/main/tests/typing/api.py). +- [ ] **New APIs** are added to our typing tests in [`api.py`](https://github.com/hynek/structlog/blob/main/tests/typing/api.py). - [ ] Updated **documentation** for changed code. - [ ] New functions/classes have to be added to `docs/api.rst` by hand. - [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded).