Skip to content

chore: add comment-hygiene rule and clean planning IDs from comments - #31

Merged
christophersesugh merged 1 commit into
mainfrom
chore/comment-hygiene-changelog-rule
Sep 26, 2026
Merged

christophersesugh merged 1 commit into
mainfrom
chore/comment-hygiene-changelog-rule

Conversation

@christophersesugh

Copy link
Copy Markdown
Contributor

New .agents/rules/changelog-and-comment-hygiene.md: hand-maintained CHANGELOG convention plus a ban on ADR/spec/ticket/stage IDs in code comments. Existing comments rewritten to describe behavior.

Docs site: shared article schema, article helpers, AuthorAvatar, Crosshair, static search index replacing the dead server endpoint, hoisted MDX maps, simplified changelog hero. Core CHANGELOG gains the missing Trials Unreleased entry.

Description

Related Issue

Fixes #

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

New .agents/rules/changelog-and-comment-hygiene.md: hand-maintained CHANGELOG convention plus a ban on ADR/spec/ticket/stage IDs in code comments. Existing comments rewritten to describe behavior.

Docs site: shared article schema, article helpers, AuthorAvatar, Crosshair, static search index replacing the dead server endpoint, hoisted MDX maps, simplified changelog hero. Core CHANGELOG gains the missing Trials Unreleased entry.
@christophersesugh christophersesugh self-assigned this Sep 26, 2026
@christophersesugh
christophersesugh merged commit fc37da1 into main Sep 26, 2026
1 of 2 checks passed
@christophersesugh
christophersesugh deleted the chore/comment-hygiene-changelog-rule branch September 26, 2026 13:31
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.

1 participant