Add CHANGELOG.md to improve change tracking and transparency

[kushivaradaraj]

Description:

I propose adding a dedicated CHANGELOG.md file to the OneBusAway Developer Documentation project. While the project currently has a release-notes.md file, a separate changelog would provide several benefits:

1. Improved transparency: A changelog offers a clear, chronological record of all notable changes, making it easier for contributors and users to understand the project's evolution.

2. Better organization: Changes can be categorised (e.g., Added, Changed, Deprecated, Removed, Fixed, Security) for quick reference.

3. Enhanced communication: It helps communicate changes to users, contributors, and maintainers more effectively.

4. Easier maintenance: A dedicated changelog is typically easier to update and maintain than release notes embedded in other documentation.

5. Industry standard: Many open-source projects use a CHANGELOG.md file, making it familiar to contributors and users.

6. Versioning support: It can clearly show changes between different versions of the documentation.

Proposed implementation:

1. Create a new CHANGELOG.md file in the root directory of the project.
2. Follow the Keep a Changelog (https://keepachangelog.com/) format for consistency.
3. Backfill recent changes from the release-notes.md file.
4. Update the README.md to mention the new CHANGELOG.md file.
5. Create guidelines for maintaining the changelog in the CONTRIBUTING.md file (if it exists, or create one if it doesn't).

Resolution

I would be interested in adding this feature by creating a CHANGELOG.md. This addition aligns with the project's goal of improving documentation and making it easier for contributors to understand and participate in the project's development.