Skip to content

Conversation

@leongdl
Copy link
Contributor

@leongdl leongdl commented Sep 15, 2025

Fixes: No specific GitHub issue - proactive documentation improvement

What was the problem/requirement? (What/Why)

The repository lacked consistent standards for commit messages and changelog formatting, leading to:

  • Inconsistent commit message formats across contributors
  • Changelog entries that were difficult to parse and understand
  • Missing migration guidance for breaking changes
  • No clear guidelines for experimental feature documentation

What was the solution? (How)

Added two comprehensive steering documents:

  1. .kiro/steering/commit_msg.md - Standardizes commit message format using conventional commits with:

    • Consistent type/scope/description structure
    • Clear examples of good vs bad commit messages
    • Breaking change notation guidelines
    • Repository-specific scope recommendations
  2. .kiro/steering/changelog_format.md - Establishes changelog formatting rules with:

    • Structured sections (Breaking Changes, Features, Bug Fixes, Experimental)
    • Detailed sentence structure guidelines for descriptions
    • Commit-to-changelog mapping rules
    • Quality checks and automation guidelines

What is the impact of this change?

  • Improved consistency: Future commits and changelog entries will follow standardized formats
  • Better user experience: Changelog descriptions will be user-focused rather than technical commit messages
  • Clearer breaking changes: Migration guidance will be consistently provided
  • Automation-ready: Guidelines support both manual and automated changelog generation
  • Contributor guidance: New contributors have clear standards to follow

How was this change tested?

This is documentation-only change. Testing involved:

  • Analyzing existing git history to identify patterns and inconsistencies
  • Reviewing current CHANGELOG.md format to understand improvement areas
  • Validating examples against real repository commit messages
  • Ensuring guidelines align with conventional commit standards

See DEVELOPMENT.md for information on running tests.

  • Have you run the unit tests? N/A - Documentation only
  • Have you run the integration tests? N/A - Documentation only
  • Have you made changes to the download or asset_sync modules? No

Was this change documented?

  • Are relevant docstrings in the code base updated? N/A - No code changes
  • Has the README.md been updated? No - These are internal steering documents

Does this PR introduce new dependencies?

  • This PR adds one or more new dependency Python packages. I acknowledge I have reviewed the considerations for adding dependencies in DEVELOPMENT.md.
  • This PR does not add any new dependencies.

Is this a breaking change?

No - This is documentation only and does not modify any public contracts.

Does this change impact security?

No - This change only adds documentation files with formatting guidelines. No security implications.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@leongdl leongdl changed the title docs(steering): add commit message and changelog format guidelines docs(kiro): add commit message and changelog format guidelines Sep 15, 2025
@github-actions github-actions bot added the waiting-on-maintainers Waiting on the maintainers to review. label Sep 15, 2025
@sonarqubecloud
Copy link

@@ -0,0 +1,191 @@
# Changelog Format Guidelines
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was generated by Kiro from datamining our own commit messages, change logs and how they correlate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to reduce the amount of time we spend thinking or debating the change log on release :)

@godobyte godobyte removed the waiting-on-maintainers Waiting on the maintainers to review. label Sep 16, 2025
@leongdl leongdl marked this pull request as ready for review September 16, 2025 18:55
@leongdl leongdl requested a review from a team as a code owner September 16, 2025 18:55
Comment on lines +34 to +35
**Current:** `feat: Add detailed tooltips to grayed-out submit button (#833)`
**Better:** `feat(gui): add tooltips to disabled submit button`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally! Love to see those automated improvements.

Comment on lines +43 to +44
**Current:** `chore(deps): update ruff requirement from ==0.12.* to ==0.13.* (#832)`
**Better:** `chore(deps): update ruff to 0.13.*`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emm dependabot always use the former one, the latter one is better?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, I'll change this so Kiro keeps dependable names.

@epmog
Copy link
Contributor

epmog commented Oct 2, 2025

Should the steering docs not point at our existing documentation that we already provide on this topic? I dislike the idea of having to maintaining the same information in multiple places.

I think that pretty accurately describes what we're looking for. With maybe one caveat that we're missing info on the "how to phrase" which we could add info for. Does Kiro struggle with using that?

@leongdl
Copy link
Contributor Author

leongdl commented Oct 2, 2025

Should the steering docs not point at our existing documentation that we already provide on this topic? I dislike the idea of having to maintaining the same information in multiple places.

I think that pretty accurately describes what we're looking for. With maybe one caveat that we're missing info on the "how to phrase" which we could add info for. Does Kiro struggle with using that?

I agree it should link to the CONTRIBUTION.md, but the contribution md is more human facing and not very "AI friendly".

The AI steering here gives it learned context of prior art to help us shape better commit messages. Its not necessarily a "human user guide".

@epmog epmog self-requested a review October 22, 2025 16:44
@epmog
Copy link
Contributor

epmog commented Jan 2, 2026

Closing this now that there's now an Agent.md added in #955 and it points at the existing documentation for changelogs and commits which I think is the right spot for all of this. If we need to improve instructions, we can update the existing docs for humans/agents.

@epmog epmog closed this Jan 2, 2026
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.

4 participants