p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
test_ok2/.github/PULL_REQUEST_TEMPLATE.md

24 lines
1.0 KiB
Markdown
Raw Normal View History

GitHub: revisit issue/PR templates [ci skip] The motivation here is to not have the same boilerplate with PRs.
2019-04-24 00:00:16 +08:00
<!--
Add issue and PR GitHub templates
2016-02-19 04:26:38 +08:00
Thanks for submitting a PR, your contribution is really appreciated!
Small change to test if pushing directly to master is disabled
2019-05-24 23:11:15 +08:00
Here is a quick checklist that should be present in PRs.
Add issue and PR GitHub templates
2016-02-19 04:26:38 +08:00
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs.
2018-02-07 08:13:04 +08:00
- [ ] Target the `master` branch for bug fixes, documentation updates and trivial changes.
Add new 'improvement' changelog category This creates a separate section from 'features' for small changes which don't usually require user intervention, such as: * Human readable session duration * New junitxml fields * Improved colors in terminal * etc. The idea is to better match user expectations about new actual features in the "Features" section of the changelog.
2019-08-10 20:26:37 +08:00
- [ ] Target the `features` branch for new features, improvements, and removals/deprecations.
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs.
2018-02-07 08:13:04 +08:00
- [ ] Include documentation when adding new features.
- [ ] Include new tests or update existing tests when applicable.
Mention small doc fixes don't need tests/changelog entries in PR template
2016-10-06 02:36:38 +08:00
Update text in PR template
2019-11-14 17:36:47 +08:00
Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
Mention small doc fixes don't need tests/changelog entries in PR template
2016-10-06 02:36:38 +08:00
Make it clear that small typos in docs don't require a CHANGELOG entry From: https://github.com/pytest-dev/pytest/pull/5273#issuecomment-493076587
2019-05-16 21:54:50 +08:00
- [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details.
Improve instructions on how to write CHANGELOG entries This makes easier for contributors to get the CHANGELOG entry right the first time.
2019-11-20 01:04:21 +08:00
Write sentences in the **past or present tense**, examples:
* *Improved verbose diff output with sequences.*
* *Terminal summary statistics now use multiple colors.*
Also make sure to end the sentence with a `.`.
Update text in PR template
2019-11-14 17:36:47 +08:00
- [ ] Add yourself to `AUTHORS` in alphabetical order.
Make whole checklist a comment to avoid incomplete TODOs in PRs
2019-11-14 18:01:40 +08:00
-->