|
|
|
````md
|
|
|
|
# `<module_name>` \<version_id\> Release Notes
|
|
|
|
|
|
|
|
We are delighted to announce the new version of `<module_name>` :tada: :tada:!
|
|
|
|
|
|
|
|
### Highlights
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here major features/changes.
|
|
|
|
This section should give the thematic fo this release (did we focus on adding tests/documentation/new feature/all of the above?)
|
|
|
|
|
|
|
|
## Contributors :smiley:
|
|
|
|
|
|
|
|
Since the previous release, the following people contributed to the project:
|
|
|
|
|
|
|
|
* @contributor_one
|
|
|
|
* @contributor_one (Mark commits author as contributors)
|
|
|
|
* @contributor_two
|
|
|
|
|
|
|
|
Thank you to all of them! :tada:
|
|
|
|
|
|
|
|
## Deprecation :raised_hand: :octagonal_sign:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here function that have been marked as deprecated.
|
|
|
|
|
|
|
|
## Expired Deprecation :wastebasket:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here function that changed API after the deprecation.
|
|
|
|
|
|
|
|
Since the deprecation system is still not very used, write here API changes even if it was not marked as deprecated in previous release.
|
|
|
|
|
|
|
|
## New Features :sparkles:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here new feature
|
|
|
|
|
|
|
|
## Improvements :art: :zap:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here every improvements on the user side! better API, performances ...
|
|
|
|
|
|
|
|
Refactorings and change on the dev side must be mentioned in the dev section.
|
|
|
|
|
|
|
|
## Bug fixes :fire: :bug:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here every bug fix that were present in the latest version.
|
|
|
|
|
|
|
|
**DO NOT** write bug fix on features added during this release! Instead these Mr should be mentioned in the line that introduce the new feature
|
|
|
|
|
|
|
|
Example:
|
|
|
|
```md
|
|
|
|
## New Features :sparkles:
|
|
|
|
- New feature ``A`` introduced (link_to_MR_that_introduced + link_to_MR_that_fix_bug)
|
|
|
|
```
|
|
|
|
|
|
|
|
## Documentation :books:
|
|
|
|
|
|
|
|
None.
|
|
|
|
Write here every addition or update to the documentation
|
|
|
|
|
|
|
|
## Developers :computer:
|
|
|
|
|
|
|
|
None. |
|
|
\ No newline at end of file |
|
|
|
Write here every features that has been added that are specific to developers.
|
|
|
|
|
|
|
|
This can be a new internal feature, a third party version update ...
|
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
\ No newline at end of file |