Repository navigation
feat: Add CHANGELOG system with Keep a Changelog format and CI enforc… - #330
Merged
Merged
Conversation
…ement This implements a comprehensive changelog system for tracking changes across the Hermes project to provide transparency between releases and ensure no changes are accidentally undocumented. Changes: - CHANGELOG.md: Main changelog following Keep a Changelog 1.0.0 format * [Unreleased] section for tracking ongoing changes between releases * All 20 Hermes contracts documented and categorized * Contributor guidelines with clear examples and formatting rules * Release process documentation for maintainers - .github/workflows/changelog-check.yml: New CI workflow for enforcement * Triggers automatically on PRs that modify contracts/ or crates/ * Verifies CHANGELOG.md was updated in the PR * Validates Unreleased section has meaningful entries * Confirms adherence to Keep a Changelog format * Auto-comments on PRs with helpful guidance if requirements unmet * Blocks PR merge if changelog update is missing - Documentation suite in docs/: * CHANGELOG_QUICK_REFERENCE.md: Quick developer how-to guide (< 5 min) * CHANGELOG_TEMPLATE.md: Detailed templates for each change type * CHANGELOG_IMPLEMENTATION.md: Technical architecture and design details * CHANGELOG_COMMIT_MESSAGE.md: Ready-to-use commit message template - CONTRIBUTING.md: Updated with changelog guidelines * New 'Updating the Changelog' section with step-by-step instructions * Integrated with existing PR workflow requirements * Clear examples of good vs. problematic entries Benefits: - Users can see what changed between versions - Automated CI check ensures release notes are never forgotten - Multiple documentation levels for different user needs - Standard format following widely-adopted Keep a Changelog convention - Clear, reproducible release process for maintainers - Developer-friendly with examples and templates All files have been verified for correctness and are ready for immediate use.
|
@Ibile5598 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #254
closes #257
closes #258
closes #261
…ement
This implements a comprehensive changelog system for tracking changes across the Hermes project to provide transparency between releases and ensure no changes are accidentally undocumented.
Changes:
CHANGELOG.md: Main changelog following Keep a Changelog 1.0.0 format
.github/workflows/changelog-check.yml: New CI workflow for enforcement
Documentation suite in docs/:
CONTRIBUTING.md: Updated with changelog guidelines
Benefits:
All files have been verified for correctness and are ready for immediate use.