Add: changelog-file.md to the Docs-for-Contributors-and-Maintainers section.

documentation/repository-files/changelog-file.md

@@ -1,19 +1,20 @@
-# Changelog.md Guide
+# CHANGELOG.md Guide
 
 ## Introduction
 
-The `changelog.md` document serves as a valuable resource for developers and users alike to track the evolution of a project over time. Understanding the structure and purpose of a changelog helps users and contributors stay informed about new features, bug fixes, and other changes introduced in each release.
+The `CHANGELOG.md` document serves as a valuable resource for developers and users alike to track the evolution of a project over time. Understanding the structure and purpose of a changelog helps users and contributors stay informed about new features, bug fixes, and other changes introduced in each release.
 
-## What is changelog.md?
+## What is CHANGELOG.md?
 
-`changelog.md` is a file commonly found in Python packages. Its primary purpose is to provide a chronological record of significant changes made to the project with each new release. This document helps users understand what has been added, fixed, or modified in the latest version of the software. In addition, it allows the contributors and users to understand the versioning syntax used for the package.
+The primary purpose of `CHANGELOG.md` is to provide a record of notable changes made to the project with each new release. This document helps users understand what has been added, fixed, modified, or removed with each version of the software.
 
-[Keep a Changelog.md](https://keepachangelog.com/en/1.1.0/) is great, simple resource for understanding what a changelog is, how to create a good changelog, and includes some pointers of things to avoid in a changelog.
+[Keep a CHAGELOG.md](https://keepachangelog.com/en/1.1.0/) is a great, simple resource for understanding what a changelog is and how to create a good changelog. It also includes examples of things to avoid.
 
-```{admonition} Semantic Versioning
+```{admonition} Versioning your Python package and semantic versioning
 :class: tip
 
 An important component of a package that serves as the backbone behind the changelog file is a good versioning scheme. Semantic Versioning is widely used across Python packages.
+* [Creating New Versions of Your Python Package](../../package-structure-code/python-package-versions.md)
 * [Semantic Versioning](https://semver.org)
 ```
 
@@ -39,58 +40,65 @@ The contents of a changelog.md file typically follow a structured format, detail
 
 - **Contributor Recognition**: Acknowledgment of contributors who made significant contributions to the release, fostering a sense of community and appreciation for their efforts.
 
-## What does it look like?
+## How do maintainers use it?
 
-```markdown
-# Change Log
-All notable changes to this project will be documented in this file.
+Often you will see a change log that documents a few things
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
+Unreleased commits at the top of the changelog, it's common to have an `## Unreleased` section. This is where you can add new fixes, updates and features that have been added to the package since the last release.
 
-## [Unreleased] - yyyy-mm-dd
+This section might look something like this:
 
-Here we write upgrading notes for brands. It's a team effort to make them as
-straightforward as possible.
+```markdown
+## Unreleased
+* Fix: Fixed a bug.... more here. (@github_username, #issuenumber)
+* Add: new feature to ...more here (@github_username, #issuenumber)
+Below the unreleased section, there will be a section for each release. In these sections, you can organize new Fixes, Additions and update together.
+## v1.0
 
-### Added
-- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
-  MINOR Ticket title goes here.
-- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
-  PATCH Ticket title goes here.
+### Updates
+* Fix: Fixed a bug.... more here. (@github_username, #issuenumber)
 
-### Changed
+### Additions
+* Add: new feature to ...more here (@github_username, #issuenumber)
+
+### Deprecations
 
-### Fixed
+### Contributors to this release
+```
 
-## [1.2.4] - 2017-03-15
+When you are ready to make a new release, you can re-organize the list of unreleased elements into a section that is specific to that new release number.
 
-Here we would have the update steps for 1.2.4 for people to follow.
+The unreleased section then always lives at the top of the file. And as new features are added after release 1.x, they get added to that section.
 
-### Added
+## What does it look like?
 
-### Changed
+This example comes from [Devicely](https://github.com/hpi-dhc/devicely/tree/main), one of the PyOpenSci reviewed and accepted packages.
 
-- [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
-  PATCH Drupal.org is now used for composer.
+```markdown
+# Changelog
+All notable changes to this project will be documented in this file.
 
-### Fixed
+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).
 
-- [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
-  PATCH Add logic to runsheet teaser delete to delete corresponding
-  schedule cards.
+## [Unreleased]
 
-## [1.2.3] - 2017-03-14
+## [1.1.0] - 2021-08-24
+- removed acceleration magnitude from devicely.EmpaticaReader and devicely.FarosReader since it was out of the scope of the package
+- added more flexibility to missing files (e.g. ACC.csv, EDA.csv) to devicely.EmpaticaReader
+- changed TagsReader to TimeStampReader to be more consistent with the class naming structure in devicely
+- deprecated methods in devicely.SpacelabsReader: set_window and drop_EB
+- fixed issue with the timestamp index and fixed column names in devicely.SpacelabsReader
 
+## [1.0.0] - 2021-07-19
 ### Added
+- devicely.FarosReader can both read from and write to EDF files and directories
+- devicely.FarosReader has as attributes the individual dataframes (ACC, ECG, ...) and not only the joined dataframe
 
 ### Changed
+- in devicely.SpacelabsReader, use xml.etree from the standard library instead of third-party "xmltodict"
+- switch from setuptools to Poetry
 
-### Fixed
-
-- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
-  MINOR Fix module foo tests
-- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
-  MAJOR Module foo's timeline uses the browser timezone for date resolution
+### Removed
+- removed setup.py because static project files such as pyproject.toml are preferred
 ```
-[Sample changelog source](https://gist.github.com/juampynr/4c18214a8eb554084e21d6e288a18a2c)

package-structure-code/python-package-distribution-files-sdist-wheel.md

@@ -207,7 +207,7 @@ stravalib-1.1.0.post2-SDist.tar.gz file contents
 ├─ Makefile
 ├─ PKG-INFO
 ├─ README.md
-├─ changelog.md
+├─ CHANGELOG.md
 ├─ environment.yml
 ├─ pyproject.toml
 ├─ requirements-build.txt