Skip to content

Commit 9043418

Browse files
authoredOct 14, 2024··
[DOC]: add next release changelog entries (#6)
1 parent 1ae54f7 commit 9043418

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed
 

‎docs/contribute/contributing.rst

+2
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ Pre-releases
167167
Pre-releases are published on PyPI for testing purposes. To create a pre-release,
168168
follow these steps:
169169

170+
0. Make sure changelog entries are up-to-date and the code is ready for release.
170171
1. Push a new tag with the version number and the pre-release suffix, e.g.,
171172
``v0.1.0a1``.
172173
2. The GitHub Actions workflow will automatically publish the pre-release to PyPI. This is the most important step, as it will test the package installation.
@@ -183,6 +184,7 @@ Releases
183184

184185
To create a new release, follow these steps:
185186

187+
0. Make sure changelog entries and it's filename are up-to-date and the code is ready for release.
186188
1. Push a new tag with the version number, e.g., ``v0.1.0``.
187189
2. The GitHub Actions workflow will automatically publish the release to PyPI.
188190
3. Install the release with pip:

‎docs/whatsnews/_next_release.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Upcoming release
2+
================
3+
4+
202x-xx-xx
5+
6+
Added
7+
-----
8+
9+
Changed
10+
-------
11+
12+
Deprecated
13+
----------
14+
15+
Removed
16+
-------
17+
18+
Fixed
19+
-----
20+
21+
Security
22+
--------
23+

0 commit comments

Comments
 (0)
Please sign in to comment.