Skip to content

Commit 1f48072

Browse files
docs: add changelog and update README to reference it
1 parent 5f5cd21 commit 1f48072

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
UPDATE changelog to include changes between given tag/commit and latest tag.
2+
Make sure we follow reverse chronological order. Each tag should be their own h2
3+
header and under the tag, we list the changes made since given tag. If there is
4+
no given tag, consider the changelog against the latest master commit. And keep
5+
them under `Unreleased` h2 header.
6+
7+
Under each h2 header, we can have the following sections:
8+
9+
```md
10+
## [Unreleased OR tag]
11+
12+
### Added
13+
14+
### Changed
15+
16+
### Deprecated
17+
18+
### Removed
19+
20+
### Fixed
21+
22+
### Security
23+
```
24+
25+
UPDATE readme to reflect those changes for the first time visitor.

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
3+
## [Unreleased]
4+
5+
### Added
6+
7+
### Changed
8+
9+
### Deprecated
10+
11+
### Removed
12+
13+
### Fixed
14+
15+
### Security

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ server binary and ensure the `VAL_TOWN_API_TOKEN` environment variable is set.
142142

143143
Contributions are welcome! Please feel free to submit a Pull Request.
144144

145+
## Changelog
146+
147+
See the [CHANGELOG](CHANGELOG.md) for a list of notable changes to this project.
148+
145149
## License
146150

147151
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

0 commit comments

Comments
 (0)