-
Notifications
You must be signed in to change notification settings - Fork 59
docs(kiro): add commit message and changelog format guidelines #842
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
docs(kiro): add commit message and changelog format guidelines #842
Conversation
Signed-off-by: David Leong <[email protected]>
|
| @@ -0,0 +1,191 @@ | |||
| # Changelog Format Guidelines | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 :)
| **Current:** `feat: Add detailed tooltips to grayed-out submit button (#833)` | ||
| **Better:** `feat(gui): add tooltips to disabled submit button` |
There was a problem hiding this comment.
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.
| **Current:** `chore(deps): update ruff requirement from ==0.12.* to ==0.13.* (#832)` | ||
| **Better:** `chore(deps): update ruff to 0.13.*` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
|
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". |
|
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. |



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:
What was the solution? (How)
Added two comprehensive steering documents:
.kiro/steering/commit_msg.md- Standardizes commit message format using conventional commits with:.kiro/steering/changelog_format.md- Establishes changelog formatting rules with:What is the impact of this change?
How was this change tested?
This is documentation-only change. Testing involved:
See DEVELOPMENT.md for information on running tests.
downloadorasset_syncmodules? NoWas this change documented?
Does this PR introduce 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.