Skip to content

Commit 74caea9

Browse files
committed
Reorder version update checklist
- Separate changelog format into own document - Correct typo in Dn0.5.2 change log
1 parent e606139 commit 74caea9

File tree

4 files changed

+40
-34
lines changed

4 files changed

+40
-34
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Last updated: December 25, 2025
7575
- Fix channel state retrieval on reset tempo (@henrikvilhelmberglund @Gumball2415 #357 #373)
7676
- Fix N163 linear mix volume quantization (@Gumball2415 #366)
7777
- Beta: Fix triangle `Xxx`-`Sxx` linear counter behavior (@Gumball2415 #355 #366)
78-
- Prevent focus shifting with open instrument editor when inputting instrument patterns (@@henrikvilhelmberglund @Gumball2415 #350 #366)
78+
- Prevent focus shifting with open instrument editor when inputting instrument patterns (@henrikvilhelmberglund @Gumball2415 #350 #366)
7979
- Fix note slide portamento reset in NSF driver (@Gumball2415 #363 #366)
8080
- Fix `1xx`/`2xx` empty note early exit (@Gumball2415 #366)
8181

docs/changelog_format.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
- Categories
3+
- `Important changes:`
4+
- summary of immediate and obvious changes to the program
5+
- `Improvements:`
6+
- additions and refactoring
7+
- `Bug fixes:`
8+
- any bug fixes
9+
- `Internal:`
10+
- meta changes, including changes regarding to the repository or CI
11+
- Format
12+
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
13+
- only put in issue author and number if it exists
14+
- only put one author if issue and commit author is the same
15+
- sort by category, then by issue number, then by PR number
16+
- ex:
17+
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
18+
- `Pick song length mode when typing length time in WAV export dialog (@nyanpasu64 #346)`

docs/version_update.md

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,10 @@
11
# Version Update Checklist
22

3+
listing out things to do so i won't forget to do them -persune
4+
35
- [ ] Update changelogs:
46
- [CHANGELOG.md](Dn-FamiTracker/CHANGELOG.md), which will update [../Dn-Help/hlp/changelog_shell.htm](changelog_shell.htm) upon build
5-
- Categories
6-
- `Important changes:`
7-
- summary of immediate and obvious changes to the program
8-
- `Improvements:`
9-
- additions and refactoring
10-
- `Bug fixes:`
11-
- any bug fixes
12-
- `Internal:`
13-
- meta changes, including changes regarding to the repository or CI
14-
- Format
15-
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
16-
- only put in issue author and number if it exists
17-
- only put one author if issue and commit author is the same
18-
- sort by category, then by issue number, then by PR number
19-
- ex:
20-
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
21-
- [ ] Create Version Tag
22-
- Format: `Dnx.y.z.b`
23-
- x: Major (API change)
24-
- y: Minor (backward compatible change)
25-
- z: Patch (backward compatible bugfix)
26-
- b: Build type (internal, not visible)
27-
- 0: stable release
28-
- 9: "dirty"/beta/in-development build
29-
- Double check that this tag is higher than the previous release tag
30-
- Version tag must be appropriate to Semantic Versioning
31-
- [ ] Edit every file with version info:`
32-
- [version.h](../version.h)
33-
- [Dn-FamiTracker.rc](../Dn-FamiTracker.rc) gets its version constants from here
34-
- [Readme.txt](../Readme.txt)
35-
- [ ] **IMPORTANT**: update ConfigVersion.cpp
7+
- see [changelog format](changelog_format.md)
368
- [ ] Update copyright years:
379
- Update License years in
3810
- [LICENSE.md](../LICENSE.md)
@@ -41,7 +13,7 @@
4113

4214
```
4315
Dn-FamiTracker - NES/Famicom sound tracker
44-
Copyright (C) 2020-2025 D.P.C.M.
16+
Copyright (C) 2020-2026 D.P.C.M.
4517
FamiTracker Copyright (C) 2005-2020 Jonathan Liss
4618
0CC-FamiTracker Copyright (C) 2014-2018 HertzDevil
4719
@@ -60,6 +32,22 @@ along with this program. If not, see https://www.gnu.org/licenses/.
6032
```
6133

6234
- [ ] ***important***: set date of release at the last moment!
35+
- [ ] Create Version Tag
36+
- Format: `Dnx.y.z.b`
37+
- x: Major (API change)
38+
- y: Minor (backward compatible change)
39+
- z: Patch (backward compatible bugfix)
40+
- b: Build type (internal, not visible)
41+
- 0: stable release
42+
- 9: "dirty"/beta/in-development build
43+
- Double check that this tag is higher than the previous release tag
44+
- Version tag's first three digits must be appropriate to Semantic Versioning
45+
- [ ] Edit every file with version info:`
46+
- [version.h](../version.h)
47+
- [Dn-FamiTracker.rc](../Dn-FamiTracker.rc) gets its version constants from here through a build script
48+
- [Readme.txt](../Readme.txt)
49+
- [ ] **IMPORTANT**: update ConfigVersion.cpp
50+
- [ ] [Dn-help update](../Dn-help/version_update.md)
6351
- [ ] Create and push Version Tag to the repo
6452
- There is a GitHub Actions script to build a drafted release upon a tag push
6553
- Tag must be on commit deemed appropriate for release

0 commit comments

Comments
 (0)