commit
Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.
Security Assessment
About commit
The 'commit' skill is designed to assist developers in creating commit messages that align with Sentry conventions. It addresses the common challenge of writing clear and structured commit messages that not only document changes but also facilitate issue tracking and project management. By following a standardized format, this skill helps ensure that commit messages are informative, consistent, and conducive to collaborative development environments, ultimately improving the quality of the code history and the efficiency of the development workflow.
This skill encompasses several key features and capabilities, including predefined commit types such as 'feat', 'fix', and 'ref', which guide developers in categorizing their changes. Additionally, it provides a structured format for commit messages that includes a subject line, body, and footer, along with specific rules for each section. The skill also emphasizes the importance of including issue references and co-author information when relevant, which can enhance collaboration and tracking within teams. Furthermore, the skill encourages best practices for commit messages, such as using imperative mood and present tense, ensuring that each commit remains focused and clear.
Target users of this skill include software developers, particularly those working in teams on Sentry projects, who need a reliable method for documenting their code changes. It is particularly beneficial for teams aiming to maintain a high standard of code quality and clear communication through their commit histories. Use cases range from individual developers making small changes to larger teams collaborating on significant features, where clear commit messages can aid in understanding the evolution of the codebase.
FAQ
How do I create a new branch for my commits?
You can create a new branch by using the command: git checkout -b <type>/<short-description>.
What should I include in the footer of my commit message?
In the footer, you should reference issues using patterns like 'Fixes GH-1234' or 'Refs LINEAR-ABC-123'.
Are there any specific requirements for the subject line?
Yes, the subject line should be in imperative mood, capitalized, and not exceed 70 characters.
Can I include personal comments or explanations in my commit messages?
It's recommended to focus on the what and why of the change rather than personal comments.
Is there a limitation on the types of changes I can document with this skill?
No, it can be used for various types of changes, including features, fixes, refactoring, and more.
Install commit
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
getsentry/skills