Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOG.md to improve change tracking and transparency #142

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kushivaradaraj
Copy link

# Description : Solving issue #141
This pull request adds a CHANGELOG.md file to the OneBusAway Developer Documentation project. While the project currently has release notes in various locations, a dedicated changelog will provide several benefits:

  1. Improved transparency: A changelog offers a clear, chronological record of all notable changes.
  2. Better organization: Changes can be categorized 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.
  5. Industry standard: Many open-source projects use a CHANGELOG.md file.
  6. Versioning support: It clearly shows changes between different versions of the documentation.

Changes made

  1. Created a new CHANGELOG.md file in the root directory.
  2. Updated README.md to mention the new CHANGELOG.md file.
  3. Updated /src/guides/outdated.md to include a link to the changelog.

How to test

  1. Check that the CHANGELOG.md file is present in the root directory.
  2. Verify that the README.md file includes a section about the changelog.
  3. Confirm that /src/guides/outdated.md includes a link to the changelog.

Additional notes

  • The CHANGELOG.md follows the Keep a Changelog format for consistency.
  • Initial entries have been added based on the existing release notes.
  • Future contributions should update the CHANGELOG.md file as part of their pull requests.

@CLAassistant
Copy link

CLAassistant commented Aug 12, 2024

CLA assistant check
All committers have signed the CLA.

@kushivaradaraj
Copy link
Author

kushivaradaraj commented Aug 12, 2024

@aaronbrethorst
Respected project maintainer,

I've added a CHANGELOG.md file to the project to improve change tracking and transparency. The changes include:

  1. Creating a new CHANGELOG.md file in the root directory.
  2. Updating README.md to mention the new CHANGELOG.md file.
  3. Updating /src/guides/outdated.md to include a link to the changelog.

Could someone please review the changes and provide feedback? Your input would be greatly appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants