You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -337,19 +337,20 @@ A central version number is stored in `pints/version`.
337
337
338
338
### New releases on PyPI (for `pip`)
339
339
340
-
Occasionally, we'll make a new release for PINTS, and update the version on PyPI (which is where `pip`will download it from, for non-dev users).
340
+
Occasionally, we'll make a new release for PINTS, and update the version on PyPI (which is where `pip`downloads come from).
341
341
342
342
To do this:
343
343
344
-
- Decide a new release is necessary, discuss it in the group.
345
-
- Make sure the version number has changed since the last release.
346
-
- Use the [GitHub releases page](https://github.com/pints-team/pints/releases/new) to create a new release. Each release will create a tag in the git repository, which should have the format `v1.2.3`.
347
-
- The first number is for big events, the second for regular releases (e.g. new features), the final for bugfixes and smaller improvements. This is subjective.
348
-
- Beyond that, there is no significance to these numbers (e.g. it doesn't matter if they're odd or even, `v0.9.9` is followed by `v0.9.10`).
349
-
- Check what has changed since the last release, and write some release notes to summarise what's new. This can be based on the [Changelog](#changelog).
350
-
- Creating the new release in github **will automatically update PyPI**, so do this with care.
351
-
- Keep in mind that PyPI version numbers are eternal: You cannot modify a release, only create a new one with a new version number.
352
-
- Once the new release is done, create a PR to update the version number (final digit) to indicate that the code in the repo is no longer the version on PIP.
344
+
1. Decide a new release is necessary by discussing it in the group.
345
+
2. Check that the version number (`pints/version`) has changed since the last release.
346
+
3. Create and merge a branch updating the [Changelog](#changelog) with the new version number and date, and create a new "Unreleased" header with empty "Added", "Changed", "Deprecated", "Removed", "Fixed" sections.
347
+
5. Use the [GitHub releases page](https://github.com/pints-team/pints/releases/new) to create a new release, and a new tag with the format `v1.2.3` - **don't forget the v**.
348
+
- The first number is for big events, the second for regular releases (e.g. new features), the final for bugfixes and smaller improvements. This is subjective.
349
+
- Beyond that, there is no significance to these numbers. It doesn't matter if they're odd or even. `v0.7.9` is followed by `v0.7.10`.
350
+
6. Write release notes summarising the major changes, based on the Changelog.
351
+
7. Finally, create the new release. **This will automatically update PyPI, so do this with care!**
352
+
- PyPI version numbers are eternal: Once created, a release cannot be modified.
353
+
8. Once the new release is done, create a PR to update the version number (final digit) to indicate that the code in the repo is no longer the version on PyPI.
0 commit comments