-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
ref: Replace inline commit/PR rules with skill references #16378
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sergical
wants to merge
2
commits into
master
Choose a base branch
from
ref/use-skills-for-commit-and-pr
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+469
−50
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| name: agents-md | ||
| description: This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Guides discovery of local skills and enforces minimal documentation style. | ||
| --- | ||
|
|
||
| # Maintaining AGENTS.md | ||
|
|
||
| AGENTS.md is the canonical agent-facing documentation. Keep it minimal—agents are capable and don't need hand-holding. | ||
|
|
||
| ## File Setup | ||
|
|
||
| 1. Create `AGENTS.md` at project root | ||
| 2. Create symlink: `ln -s AGENTS.md CLAUDE.md` | ||
|
|
||
| ## Before Writing | ||
|
|
||
| Discover local skills to reference: | ||
|
|
||
| ```bash | ||
| find .claude/skills -name "SKILL.md" 2>/dev/null | ||
| ls plugins/*/skills/*/SKILL.md 2>/dev/null | ||
| ``` | ||
|
|
||
| Read each skill's frontmatter to understand when to reference it. | ||
|
|
||
| ## Writing Rules | ||
|
|
||
| - **Headers + bullets** - No paragraphs | ||
| - **Code blocks** - For commands and templates | ||
| - **Reference, don't duplicate** - Point to skills: "Use `db-migrate` skill. See `.claude/skills/db-migrate/SKILL.md`" | ||
| - **No filler** - No intros, conclusions, or pleasantries | ||
| - **Trust capabilities** - Omit obvious context | ||
|
|
||
| ## Required Sections | ||
|
|
||
| ### Package Manager | ||
| Which tool and key commands only: | ||
| ```markdown | ||
| ## Package Manager | ||
| Use **pnpm**: `pnpm install`, `pnpm dev`, `pnpm test` | ||
| ``` | ||
|
|
||
| ### Commit Attribution | ||
| Always include this section. Agents should use their own identity: | ||
| ```markdown | ||
| ## Commit Attribution | ||
| AI commits MUST include: | ||
| ``` | ||
| Co-Authored-By: (the agent model's name and attribution byline) | ||
| ``` | ||
| Example: `Co-Authored-By: Claude Sonnet 4 <noreply@example.com>` | ||
| ``` | ||
|
|
||
| ### Key Conventions | ||
| Project-specific patterns agents must follow. Keep brief. | ||
|
|
||
| ### Local Skills | ||
| Reference each discovered skill: | ||
| ```markdown | ||
| ## Database | ||
| Use `db-migrate` skill for schema changes. See `.claude/skills/db-migrate/SKILL.md` | ||
|
|
||
| ## Testing | ||
| Use `write-tests` skill. See `.claude/skills/write-tests/SKILL.md` | ||
| ``` | ||
|
|
||
| ## Optional Sections | ||
|
|
||
| Add only if truly needed: | ||
| - API route patterns (show template, not explanation) | ||
| - CLI commands (table format) | ||
| - File naming conventions | ||
|
|
||
| ## Anti-Patterns | ||
|
|
||
| Omit these: | ||
| - "Welcome to..." or "This document explains..." | ||
| - "You should..." or "Remember to..." | ||
| - Content duplicated from skills (reference instead) | ||
| - Obvious instructions ("run tests", "write clean code") | ||
| - Explanations of why (just say what) | ||
| - Long prose paragraphs | ||
|
|
||
| ## Example Structure | ||
|
|
||
| ```markdown | ||
| # Agent Instructions | ||
|
|
||
| ## Package Manager | ||
| Use **pnpm**: `pnpm install`, `pnpm dev` | ||
|
|
||
| ## Commit Attribution | ||
| AI commits MUST include: | ||
| ``` | ||
| Co-Authored-By: (the agent model's name and attribution byline) | ||
| ``` | ||
|
|
||
| ## API Routes | ||
| [Template code block] | ||
|
|
||
| ## Database | ||
| Use `db-migrate` skill. See `.claude/skills/db-migrate/SKILL.md` | ||
|
|
||
| ## Testing | ||
| Use `write-tests` skill. See `.claude/skills/write-tests/SKILL.md` | ||
|
|
||
| ## CLI | ||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `pnpm cli sync` | Sync data | | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| --- | ||
| name: commit | ||
| description: 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. | ||
| --- | ||
|
|
||
| # Sentry Commit Messages | ||
|
|
||
| Follow these conventions when creating commits for Sentry projects. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before committing, ensure you're working on a feature branch, not the main branch. | ||
|
|
||
| ```bash | ||
| # Check current branch | ||
| git branch --show-current | ||
| ``` | ||
|
|
||
| If you're on `main` or `master`, create a new branch first: | ||
|
|
||
| ```bash | ||
| # Create and switch to a new branch | ||
| git checkout -b <type>/<short-description> | ||
| ``` | ||
|
|
||
| Branch naming should follow the pattern: `<type>/<short-description>` where type matches the commit type (e.g., `feat/add-user-auth`, `fix/null-pointer-error`, `ref/extract-validation`). | ||
|
|
||
| ## Format | ||
|
|
||
| ``` | ||
| <type>(<scope>): <subject> | ||
|
|
||
| <body> | ||
|
|
||
| <footer> | ||
| ``` | ||
|
|
||
| The header is required. Scope is optional. All lines must stay under 100 characters. | ||
|
|
||
| ## Commit Types | ||
|
|
||
| | Type | Purpose | | ||
| |------|---------| | ||
| | `feat` | New feature | | ||
| | `fix` | Bug fix | | ||
| | `ref` | Refactoring (no behavior change) | | ||
| | `perf` | Performance improvement | | ||
| | `docs` | Documentation only | | ||
| | `test` | Test additions or corrections | | ||
| | `build` | Build system or dependencies | | ||
| | `ci` | CI configuration | | ||
| | `chore` | Maintenance tasks | | ||
| | `style` | Code formatting (no logic change) | | ||
| | `meta` | Repository metadata | | ||
| | `license` | License changes | | ||
|
|
||
| ## Subject Line Rules | ||
|
|
||
| - Use imperative, present tense: "Add feature" not "Added feature" | ||
| - Capitalize the first letter | ||
| - No period at the end | ||
| - Maximum 70 characters | ||
|
|
||
| ## Body Guidelines | ||
|
|
||
| - Explain **what** and **why**, not how | ||
| - Use imperative mood and present tense | ||
| - Include motivation for the change | ||
| - Contrast with previous behavior when relevant | ||
|
|
||
| ## Footer: Issue References | ||
|
|
||
| Reference issues in the footer using these patterns: | ||
|
|
||
| ``` | ||
| Fixes GH-1234 | ||
| Fixes #1234 | ||
| Fixes SENTRY-1234 | ||
| Refs LINEAR-ABC-123 | ||
| ``` | ||
|
|
||
| - `Fixes` closes the issue when merged | ||
| - `Refs` links without closing | ||
|
|
||
| ## AI-Generated Changes | ||
|
|
||
| When changes were primarily generated by a coding agent (like Claude Code), include the Co-Authored-By attribution in the commit footer: | ||
|
|
||
| ``` | ||
| Co-Authored-By: Claude <noreply@anthropic.com> | ||
| ``` | ||
|
|
||
| This is the only indicator of AI involvement that should appear in commits. Do not add phrases like "Generated by AI", "Written with Claude", or similar markers in the subject, body, or anywhere else in the commit message. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Simple fix | ||
|
|
||
| ``` | ||
| fix(api): Handle null response in user endpoint | ||
|
|
||
| The user API could return null for deleted accounts, causing a crash | ||
| in the dashboard. Add null check before accessing user properties. | ||
|
|
||
| Fixes SENTRY-5678 | ||
| Co-Authored-By: Claude <noreply@anthropic.com> | ||
| ``` | ||
|
|
||
| ### Feature with scope | ||
|
|
||
| ``` | ||
| feat(alerts): Add Slack thread replies for alert updates | ||
|
|
||
| When an alert is updated or resolved, post a reply to the original | ||
| Slack thread instead of creating a new message. This keeps related | ||
| notifications grouped together. | ||
|
|
||
| Refs GH-1234 | ||
| ``` | ||
|
|
||
| ### Refactor | ||
|
|
||
| ``` | ||
| ref: Extract common validation logic to shared module | ||
|
|
||
| Move duplicate validation code from three endpoints into a shared | ||
| validator class. No behavior change. | ||
| ``` | ||
|
|
||
| ### Breaking change | ||
|
|
||
| ``` | ||
| feat(api)!: Remove deprecated v1 endpoints | ||
|
|
||
| Remove all v1 API endpoints that were deprecated in version 23.1. | ||
| Clients should migrate to v2 endpoints. | ||
|
|
||
| BREAKING CHANGE: v1 endpoints no longer available | ||
| Fixes SENTRY-9999 | ||
| ``` | ||
|
|
||
| ## Revert Format | ||
|
|
||
| ``` | ||
| revert: feat(api): Add new endpoint | ||
|
|
||
| This reverts commit abc123def456. | ||
|
|
||
| Reason: Caused performance regression in production. | ||
| ``` | ||
|
|
||
| ## Principles | ||
|
|
||
| - Each commit should be a single, stable change | ||
| - Commits should be independently reviewable | ||
| - The repository should be in a working state after each commit | ||
|
|
||
| ## References | ||
|
|
||
| - [Sentry Commit Messages](https://develop.sentry.dev/engineering-practices/commit-messages/) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.