-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(releases): write template for rough releases
Fix of #206
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
This is a template for "hard" releases of the project, or rather their storage and | ||
sending in parallel not only to the patchnote (changelog), but also to the release | ||
notes at the same time, roughly speaking, this is a representation of the connection | ||
of release notes with the changelog in an arbitrary form for the purpose of distributing | ||
and storing the history of releases. | ||
|
||
There is a methodology (methodology) for working with these files, their creation: | ||
|
||
1. Files should be named in the semantic version of releases, more details (prefix | ||
`v` at personal discretion):\ | ||
<https://semver.org/#semantic-versioning-200> | ||
2. Files are divided into two parts: the release in your own words and the changelog | ||
clone: | ||
3. In your own words, the retelling of the release is usually automated by LLMs, | ||
but manual retelling is welcomed; | ||
4. The changelog does not change when copying from the original file (CHANGELOG.md), | ||
with the exception of extreme validation errors (broken links, etc.); | ||
5. Repeating the version tag in the release file is NOT WELCOME, that's what the | ||
file name is for. |