Skip to content

Commit 8b467dc

Browse files
authored
Add optional policies for changelog and semantic versioning. (#6)
1 parent 1dcbce7 commit 8b467dc

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All notable changes to the ICTU GitHub policy will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## v1.0.0 - 2022-07-05
8+
9+
### Added
10+
11+
- Added an optional policy about semantic versioning. Closes [#2](https://github.com/ICTU/github-policy/issues/2).
12+
- Added a changelog.
13+

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ ICTU projects, departments, and employees using GitHub should follow the guideli
2727

2828
### For repositories
2929

30-
- Repositories have a `publiccode.yml` file in the root of the repository, a [metadata description standard](https://github.com/publiccodeyml/publiccode.yml) for public software in order to make the software easily discoverable. See [publiccode.yml](./publiccode.yml) for an example.
30+
- Repositories have a `publiccode.yml` file in the root of the repository, a [metadata description standard](https://github.com/publiccodeyml/publiccode.yml) for public software in order to make the software easily discoverable. See [publiccode.yml](publiccode.yml) for an example.
31+
- Repositories have a `CHANGELOG.md` file describing relevant changes to the repository contents. The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). See [CHANGELOG.md](CHANGELOG.md) for an example.
32+
- Repositories use [Semantic Versioning](https://semver.org/spec/v2.0.0.html) to version the repository contents.
3133

3234
## Get in touch
3335

0 commit comments

Comments
 (0)