@@ -67,24 +67,32 @@ your patch gets accepted:
67
67
68
68
.. keep this in sync with the description of PULL_REQUEST_TEMPLATE.md!
69
69
70
- - Create a news fragment with `towncrier create <IssueNumber>.<type> ` which will be
71
- included in the changelog. `<type> ` can be one of: breaking, user_action, feature,
72
- new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal.
73
- If necessary you can write details or offer examples on how the new change is supposed to work.
70
+ - Document your change, if it is a non-trivial one:
74
71
75
- - Document your change, if it is a non-trivial one.
72
+ * A maintainer might label the issue ``skip-news `` if the change does not need to be in the changelog.
73
+ * Otherwise, create a news fragment with ``towncrier create <IssueNumber>.<type> `` which will be
74
+ included in the changelog. ``<type> `` can be one of the types defined in `./towncrier.toml `.
75
+ If necessary you can write details or offer examples on how the new change is supposed to work.
76
+ * Generating the doc is done with ``tox -e docs ``
76
77
77
- - If you used multiple emails or multiple names when contributing, add your mails
78
- and preferred name in the ``script/.contributors_aliases.json `` file.
78
+ - Send a pull request from GitHub (see `About pull requests `_ for more insight about this topic).
79
79
80
- - Write a comprehensive commit message
81
-
82
- - Relate your change to an issue in the tracker if such an issue exists (see
80
+ - Write comprehensive commit messages and/or a good description of what the PR does.
81
+ Relate your change to an issue in the tracker if such an issue exists (see
83
82
`Closing issues via commit messages `_ of the GitHub documentation for more
84
83
information on this)
85
84
86
- - Send a pull request from GitHub (see `About pull requests `_ for more insight
87
- about this topic)
85
+ - Keep the change small, separate the consensual changes from the opinionated one.
86
+
87
+ * Don't hesitate to open multiple PRs if the change requires it. If your review is so
88
+ big it requires to actually plan and allocate time to review, it's more likely
89
+ that it's going to go stale.
90
+ * Maintainers might have multiple 5 to 10 minutes review windows per day, Say while waiting
91
+ for their teapot to boil, or for their partner to recover from their hilarious nerdy joke,
92
+ but only one full hour review time per week, if at all.
93
+
94
+ - If you used multiple emails or multiple names when contributing, add your mails
95
+ and preferred name in the ``script/.contributors_aliases.json `` file.
88
96
89
97
.. _`Closing issues via commit messages` : https://github.blog/2013-01-22-closing-issues-via-commit-messages/
90
98
.. _`About pull requests` : https://support.github.com/features/pull-requests
0 commit comments