bob/gemini-settings
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update git guidelines in GEMINI.md

Browse Source 
Add comprehensive rules for Git usage, including branching protocols,
worktree suggestions, safety checks (git diff), and history management.
Establish discovery steps for repo-specific branching and worktree
suitability. Ensure commits are atomic and separate functional logic
from linting/whitespace changes.
This commit is contained in:
bob walker
2026-02-06 16:49:54 +00:00
parent c94f4a4665
commit 9d9bb52f93
1 changed files with 25 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
GEMINI.md
View File

@@ -1,7 +1,7 @@
## Core Guidelines ## Core Guidelines
- **Persona:** Assume the user is a 30-year veteran system administrator. Skip explanations of basic concepts. Be direct, technical, and concise. - **Persona:** Assume the user is a 30-year veteran system administrator. Skip explanations of basic concepts. Be direct, technical, and concise.
- **Direct Action:** Edit files directly to fulfill requests. Do not offer to commit, create pull requests, or discuss branching unless explicitly asked. - **Direct Action:** Edit files directly. Do not commit or branch autonomously; always ask for permission first. Proactively suggest logical points for atomic commits and suggest new branches if the work deviates from the current scope or a significant task shift occurs.
- **Code Comments:** Use them sparingly. Only explain complex "why" logic. Never explain "what" the code is doing. - **Code Comments:** Use them sparingly. Only explain complex "why" logic. Never explain "what" the code is doing.
- **Project Discovery:** - **Project Discovery:**
- Always check for a `Makefile` or `scripts/` directory first for build/test/lint commands. - Always check for a `Makefile` or `scripts/` directory first for build/test/lint commands.
@@ -16,3 +16,25 @@
- Always write a test if a framework exists. Match the existing style (e.g., table-driven tests in Go). - Always write a test if a framework exists. Match the existing style (e.g., table-driven tests in Go).
- Respect `.gitignore` and `.editorconfig`. - Respect `.gitignore` and `.editorconfig`.
- **Shell Usage:** Prefer non-interactive commands with silent/quiet flags (e.g., `apt-get -y`, `npm install --quiet`). - **Shell Usage:** Prefer non-interactive commands with silent/quiet flags (e.g., `apt-get -y`, `npm install --quiet`).
- **Git Branching:**
- **Discovery:** On new repo entry, ask "Does this repo require feature branches?". Record answer in the repo's `GEMINI.md`.
- Use a new branch for each feature or bug fix.
- include ticket/issue number in branch name if available (e.g., `123-add-login`).
- Naming convention: `description` (e.g., `add-login`, `memory-leak`).
- Branch from the default branch (`main` or `master`) and keep branches short-lived.
- Rebase from the default branch frequently to avoid conflicts.
- **Git Worktrees:**
- Suggest `git worktree` for parallel tasks or frequent context switching.
- **Discovery:** On new repo entry, ask "Is this repo suitable for worktrees?". Record answer in the repo's `GEMINI.md`.
- **Git Safety & History:**
- **Pre-commit:** Always run `git diff` (or `git diff --staged`) to verify changes before asking to commit.
- **Force Push:** Permitted *only* on private feature branches (`--force-with-lease`). Never on shared/main branches.
- **Conflicts:** If a rebase/merge encounters complex conflicts, abort and ask for guidance.
- **Cleanup:** Squash "wip" or "fix typo" commits into the main feature commit before final merge instructions.
- **Git Commits:**
- Use present tense, imperative mood (e.g., `resolve memory leak`).
- Keep summary <= 50 chars; wrap body at 72 chars.
- Explain _why_ in the body, not _what_.
- Reference issue/ticket numbers if available (e.g., `Fixes #456`).
- Keep commits atomic; one logical change per commit.
- Separate whitespace and linting changes into their own commits, distinct from functional logic changes.