Skip to content

Commit bef2f52

Browse files
chryslehynek
andauthored
Added example for version docstrings to PR template (#1127)
* Added example for version docstrings * Update .github/PULL_REQUEST_TEMPLATE.md --------- Co-authored-by: Hynek Schlawack <[email protected]>
1 parent c4c6fdd commit bef2f52

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ If your pull request is a documentation fix or a trivial typo, feel free to dele
2525
- [ ] Changes to the signature of `@attr.s()` have to be added by hand too.
2626
- [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded).
2727
The next version is the second number in the current release + 1.
28-
So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0.
28+
The first number represents the current year.
29+
So if the current version on PyPI is 22.2.0, the next version is gonna be 22.3.0.
30+
If the next version is the first in the new year, it'll be 23.1.0.
2931
- [ ] Documentation in `.rst` files is written using [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/).
3032
- [ ] Changes (and possible deprecations) have news fragments in [`changelog.d`](https://github.com/python-attrs/attrs/blob/main/changelog.d).
3133
- [ ] Consider granting [push permissions to the PR branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork), so maintainers can fix minor issues themselves without pestering you.

0 commit comments

Comments
 (0)