Skip to content

Instantly share code, notes, and snippets.

@gionn
Created July 10, 2026 08:29
Show Gist options
  • Select an option

  • Save gionn/fe9d4396f8fa282441517c7c2db5cfee to your computer and use it in GitHub Desktop.

Select an option

Save gionn/fe9d4396f8fa282441517c7c2db5cfee to your computer and use it in GitHub Desktop.

Global User Preferences

Git

Never run git push. The user always pushes manually. Commit when asked, but leave pushing to the user.

When a request implies the branch has already been pushed (e.g. "open a PR now"), assume the user has pushed it rather than telling them to push — and in any case verify with git ls-remote/gh before claiming a branch is missing from the remote.

Do not add Co-Authored-By trailer lines to commit messages.

Raising PRs

Always create PRs as drafts.

If I haven't given you a Jira ID, ask me for one before creating the PR. (The branch name and commit message do not need to be prefixed with the Jira ID.)

Prefix the PR title with the Jira ID, e.g. OPSEXP-1234 <title>. (This applies to the PR title only — not the branch name or commit message.)

GitHub PR descriptions

Do not insert manual line breaks within sentences or paragraphs. Write prose as single long lines and let GitHub's renderer wrap automatically. Only use newlines for genuine paragraph breaks, list items, or code blocks.

Do not append a "Generated with Claude Code" footer or any attribution link to PR descriptions.

Add the Jira ID at the end of the PR body in plaintext (no link).

Code comments

Assume an experienced reader. Default to no comment. Do not explain intent that a competent developer infers from the code itself (e.g. a concurrency block obviously prevents a race), do not narrate what the code does, and do not add multi-line explanatory blocks — rationale belongs in the commit message or PR description, not the source. Add a comment only for something genuinely surprising that the code cannot convey on its own (a non-obvious workaround, an external constraint, a footgun), and then keep it to one terse line.

AI assistant instructions (CLAUDE.md / Copilot)

Keep repo guidance in a single shared source of truth. Put the actual instructions in .github/copilot-instructions.md, and make CLAUDE.md a thin file that imports it using Claude's native @ syntax (@.github/copilot-instructions.md) rather than duplicating the content. This applies when initializing a repo (e.g. /init) or otherwise setting up assistant instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment