Git Workflow
DO NOT COMMIT unless user explicitly tells you to. Use this skill EVERY SINGLE TIME before creating a git commit. Provides mandatory commit message format, staging rules, and post-commit summary requirements for the MIRA project
Security Assessment
About Git Workflow
The Git Workflow skill is designed to enforce standardized Git practices within the MIRA project. It addresses the challenges of maintaining consistent commit messages, avoiding accidental commits, and ensuring proper synchronization between multiple repositories. This skill is mandatory before every Git commit and ensures that developers follow best practices for staging, committing, and summarizing their work, while also facilitating a smooth process for syncing with the public OSS repository when necessary.
Key features of this skill include a structured commit message format, clear staging rules, and post-commit summaries. The commit message format requires developers to follow a specific structure: CONTEXT → INSIGHT → APPROACH → CHANGES. Additionally, the skill enforces safe staging practices, urging users to never commit without explicit approval and to stage only the necessary files. The post-commit summary provides a clear, concise overview of the commit, including key accomplishments and the files changed. The skill also facilitates the synchronization of private and public repositories, offering the option to automatically sync changes to the OSS repository.
This skill is primarily targeted at developers working on the MIRA project who need to ensure that their Git commits are consistent, clear, and properly staged. It is also useful for teams looking to maintain high-quality documentation of code changes and ensure smooth collaboration across repositories.
FAQ
What should I do before making a commit?
Before every commit, you must ask if you need to sync to the OSS repository after the commit. If yes, the `./makeoss.sh` script will be run to sync with the public repository.
Can I use `git add -A` or `git add .`?
No, you should never use `git add -A` or `git add .` unless explicitly allowed. Always review and stage specific files only.
What happens if I forget to follow the commit message format?
It is critical to follow the commit message format, as it helps maintain clear and consistent documentation. Failure to follow the format may result in unclear commit histories and confusion in future code reviews.
Do I need to provide a post-commit summary?
Yes, after every commit, you are required to provide a detailed post-commit summary outlining the key accomplishments and files changed.
Is this workflow specific to MIRA only?
Yes, this workflow is tailored to the MIRA project, and it may not apply to other projects unless adapted accordingly.
Install Git Workflow
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
taylorsatula/mira-OSS