feat: add template for CHANGELOG.txt (#184)

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
Orange-OpenSource · Jan 8, 2025 · c129406 · c129406
1 parent 7bf7f76
commit c129406
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/samples/CHANGELOG.md b/samples/CHANGELOG.md
@@ -0,0 +1,35 @@
+<!-- Inspired by OUDS iOS file: https://github.com/Orange-OpenSource/ouds-ios/blob/develop/CHANGELOG.md -->
+
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+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).
+
+<!-- For example:
+ ## [Unreleased](https://github.com/Orange-OpenSource/ouds-ios/compare/0.8.0...develop) 
+ or
+ ## [0.8.0](https://github.com/Orange-OpenSource/ouds-ios/compare/0.7.0...0.8.0) - 2024-12-18
+ -->
+## [Unreleased](project-url-pointinto-last-tag...default-branch)
+
+<!-- TODO: Keep only non empty sections -->
+### Added
+
+...
+
+### Changed
+
+...
+
+### Removed
+
+...
+
+### Fixed
+
+...
+
+### Security
+
+...
diff --git a/samples/NOTICE.txt b/samples/NOTICE.txt
@@ -7,8 +7,10 @@ or displayed on this website and owned by Orange SA and its subsidiaries,
 in whole or part of, in any medium, except as required for reasonable and customary use in describing the origin of the software
 and reproducing the content of the NOTICE and DOCUMENTATION files.
 Any use or displaying shall constitute an infringement under intellectual property laws of France and international conventions.
+
 The parts are:
 
+...
 
 
 

diff --git a/samples/README.md b/samples/README.md
@@ -12,6 +12,7 @@ This directory contains several files samples you can use or pick and update for
 8. **feature_request.yml**: GitHub issue template for feature request, to place in .github folder
 9. **THIRD_PARTY.md**: File listing third-party elements
 10. **NOTICE.txt**: If some files are for example proprietary but are still versionned and accessible (inspired by [OUDS iOS file](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/NOTICE.txt))
+11. **CHANGELOG.md**: template for a CHANGELOG
 
 Some templates are missing because very dependant to the project, but here are some resources: