Skip to content
Snippets Groups Projects
Commit eeafd616 authored by René Paris's avatar René Paris
Browse files

Merge branch 'feat/update_doc' into 'master'

doc: Clarify how MantleAPI deals with versioning

Closes #43

See merge request !131
parents 7de823c0 ca9e0f90
No related branches found
No related tags found
1 merge request!131doc: Clarify how MantleAPI deals with versioning
Pipeline #33312 passed
......@@ -125,3 +125,31 @@ Add doxygen, graphiz, and cmake to at least the current users PATH variable.
```
The generated html doc is located here: `<path_to_mantle_api>/build/doc/html/index.html`
## Developer Notes
### Versioning
Versioning should follow the semantic versioning pattern `MAJOR.MINOR.PATCH`.
Currently this is a manual task that needs to be approved as a part of a code review.
In the following a course guideline is given, when to increment the according fields:
**Major:**
- Even minor changes to a public header will most likely result in an increase of this number (= breaking change).
As this is probably the most common case MAJOR will therefore be incremented relatively frequently compared to other libraries.
**Minor:**
- Increments, if changes are ABI compatible, i.e. independent of the rest of other mantle definitions.
It is expected that this does not happen very often at the current state of development.
- Features related to testing, such as enhancing mocks, adding tests, etc.
- Features related to chore tasks, such as CI scripts, CMake enhancements, formatters, etc.
**Patch:**
- Fixing typos in the documentation (as long as they don't change the semantic of a function call!)
- Fixing bugs related to testing
- Fixing bugs related to chore tasks
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment