Simplify project documentation and release notes
This commit is contained in:
18
releases/README.md
Normal file
18
releases/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Releases
|
||||
|
||||
This directory stores packaged release artifacts and per-release notes.
|
||||
|
||||
Rules:
|
||||
- keep release notes next to the matching release directory as `RELEASE_NOTES.md`;
|
||||
- do not keep duplicate changelog memory files elsewhere in the repository;
|
||||
- if a release directory has no notes yet, add them there instead of creating side documents.
|
||||
|
||||
Current convention:
|
||||
|
||||
```text
|
||||
releases/
|
||||
v1.5.0/
|
||||
RELEASE_NOTES.md
|
||||
SHA256SUMS.txt
|
||||
qfs-...
|
||||
```
|
||||
Reference in New Issue
Block a user