Commit aba4363319b0fb215fee3e22f5e5276f67f4a299
0 parents
Exists in
master
and in
4 other branches
First documentation files
Showing
3 changed files
with
28 additions
and
0 deletions
Show diff stats
| 1 | +++ a/CHANGELOG.md | |
| ... | ... | @@ -0,0 +1,25 @@ |
| 1 | +# Changelog | |
| 2 | +All notable changes to this project will be documented in this file. | |
| 3 | + | |
| 4 | +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | |
| 5 | +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). | |
| 6 | + | |
| 7 | +Version numbering will follow those principles: | |
| 8 | +- MAJOR: for big changes, like inner architecture | |
| 9 | +- MINOR: for new functionnalities, like adding hardware and corresponding servers and clients. | |
| 10 | +- PATCH: when fixing bugs or adding very small details for previous MINOR functionnality. | |
| 11 | + | |
| 12 | +`Unreleased` version holds ongoing changes. | |
| 13 | + | |
| 14 | +Changes are kept under subsections: | |
| 15 | +- `New` for new features. | |
| 16 | +- `Changed` for changes in existing functionality. | |
| 17 | +- `Deprecated` for soon-to-be removed features. | |
| 18 | +- `Removed` for now removed features. | |
| 19 | +- `Fixed` for any bug fixes. | |
| 20 | +- `Security` in case of vulnerabilities. | |
| 21 | + | |
| 22 | +Should be noted only functionnal changes, | |
| 23 | +or major refactoring improvments. | |
| 24 | + | |
| 25 | +## Unreleased | ... | ... |