Skip to content

docs: document conventional commit prefixes#147

Merged
oshikiri merged 1 commit into
masterfrom
codex/add-conventional-commit-prefixes
Oct 28, 2025
Merged

docs: document conventional commit prefixes#147
oshikiri merged 1 commit into
masterfrom
codex/add-conventional-commit-prefixes

Conversation

@oshikiri

Copy link
Copy Markdown
Owner

Summary

  • document the conventional commit prefixes and breaking change guidance in AGENTS.md

Testing

  • not run

https://chatgpt.com/codex/tasks/task_e_6900c9c41548832b92ca93b6d907c8e5

@coderabbitai

coderabbitai Bot commented Oct 28, 2025

Copy link
Copy Markdown

Warning

Rate limit exceeded

@oshikiri has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 32 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 66f0769 and a84c899.

📒 Files selected for processing (1)
  • AGENTS.md (1 hunks)
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/add-conventional-commit-prefixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces documentation for conventional commit message standards by creating a new AGENTS.md file. The document establishes guidelines for commit prefixes and breaking change notation to standardize version control practices in the repository.

Key changes:

  • Added AGENTS.md with conventional commit prefix definitions
  • Documented breaking change notation guidelines

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
Comment on lines +6 to +7
- `feat`: Use when adding new features, applying formatting-only visual changes, or improving performance.
- `fix`: Use for bug fixes.

Copilot AI Oct 28, 2025

Copy link

Choose a reason for hiding this comment

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

The feat prefix definition is too broad. By conventional commit standards, formatting-only changes should use style prefix, and performance improvements might warrant a separate perf prefix. The current definition conflates multiple distinct change types that have different semantic versioning implications.

Suggested change
- `feat`: Use when adding new features, applying formatting-only visual changes, or improving performance.
- `fix`: Use for bug fixes.
- `feat`: Use when adding new features.
- `fix`: Use for bug fixes.
- `style`: Use for formatting-only changes (e.g., code style, whitespace, visual formatting).
- `perf`: Use for performance improvements.

Copilot uses AI. Check for mistakes.
@oshikiri oshikiri merged commit 45398fa into master Oct 28, 2025
3 checks passed
@oshikiri oshikiri deleted the codex/add-conventional-commit-prefixes branch October 28, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants