Skip to content

Commit b598e6e

Browse files
committed
DEVELOPING.md: a point to keep in mind about old branch maintainence
1 parent 6b170da commit b598e6e

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

doc/DEVELOPING.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Developing in a single language is also easier for everyone involved in the
2929
project.
3030

3131
We aim to support the oldest [Python version](https://devguide.python.org/versions/)
32-
still receiving security updates, up to the latest.
33-
32+
still receiving security updates, up to the latest. In any case, there's no rush to
33+
bump the minimum version requirement unless it brings a new feature that we need.
3434

3535
### GTK
3636

@@ -249,13 +249,15 @@ within 24 hours. In order to preserve author information for commits, use the
249249

250250
Nicotine+ uses the following versioning scheme: `A.B.C`, e.g. `3.3.8`
251251

252-
- A is incremented when major changes are made to the user interface that
252+
- `A` is incremented when major changes are made to the user interface that
253253
significantly change the workflow of the application. In practice, this is
254254
unlikely to happen.
255-
- B is incremented when significant features or new dependencies are added,
255+
- `B` is incremented when significant features or new dependencies are added,
256256
version requirements are increased, or in the case of major changes to
257-
existing code that are deemed too intrusive for a smaller release.
258-
- C is incremented when bug fixes, performance improvements or smaller
257+
existing code that are deemed too intrusive for a smaller release. The
258+
previous feature branch (e.g. `3.3.x`) is created in case any critical bugs
259+
are discovered while the next planned release is still in development.
260+
- `C` is incremented when bug fixes, performance improvements or smaller
259261
tweaks to existing functionality are made. Low-risk functionality that does
260262
not affect translatable strings can also be added.
261263

@@ -271,6 +273,9 @@ volunteers in their spare time. However, keep the following points in mind:
271273
releases before they can be delivered to users.
272274
- Releasing large updates can make it more difficult to pinpoint eventual
273275
issues that were introduced since the previous release.
276+
- The final bug fix release (`C`) of each feature branch (`B`) has to be very
277+
stable before any dependency requirements are bumped, because legacy users
278+
might end up needing to use an old version for a long time.
274279

275280
### Creating a Nicotine+ Release
276281

0 commit comments

Comments
 (0)