Skip to content

Commit 4a5174b

Browse files
authored
feat(changelog): add version scoping section (#1)
1 parent 92d4f07 commit 4a5174b

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
# CHANGELOG
22

3+
## Versioning
4+
5+
This library is versioned based on Semantic Versioning ([SemVer](https://semver.org/)).
6+
7+
#### Version scoping
8+
9+
The scope of what is covered by the version number excludes:
10+
11+
- error messages; the text of the messages can change, unless specifically documented.
12+
313
#### Releasing new versions
414

515
- create a release branch
616
- update the changelog below
7-
- update version and copyright-years in `./LICENSE` and `./src/[module-name]/init.lua` (in doc-comments
17+
- update version and copyright-years in `./LICENSE.md` and `./src/[module-name]/init.lua` (in doc-comments
818
header, and in module constants)
919
- create a new rockspec and update the version inside the new rockspec:<br/>
1020
`cp [module-name]-scm-1.rockspec ./rockspecs/[module-name]-X.Y.Z-1.rockspec`
@@ -18,6 +28,8 @@
1828
- test the newly created rock:<br/>
1929
`luarocks install [module-name]`
2030

31+
## Version history
32+
2133
### Version X.Y.Z, unreleased
2234

2335
- a fix

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ See [LICENSE.md](LICENSE.md)
1616

1717
See [online documentation](https://[github-account-name].github.io/[repo-name]/)
1818

19-
## Changelog
19+
## Changelog & Versioning
2020

2121
See [CHANGELOG.md](CHANGELOG.md)

0 commit comments

Comments
 (0)