mirror of
https://github.com/getsentry/skills.git
synced 2026-09-14 20:00:03 +08:00
David Cramer
fe1dd4f1d4
* docs: list all available skills * docs(skills): Align registration guidance and skill allowlists Require alphabetical ordering when updating the Available Skills table\nin contributor guidance and skill creation workflow docs.\n\nSynchronize skill allowlists with the actual sentry-skills directory so\nautomatic skill injection guidance reflects all available skills.\n\nCo-Authored-By: GPT-5 Codex <noreply@openai.com> --------- Co-authored-by: shuofengzhang <sofuncheung16@gmail.com>
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# Contributing
|
|
|
|
## Philosophy
|
|
|
|
This repository favors **incremental change** over perfection. Skills are living documents that improve over time through small, iterative updates.
|
|
|
|
- **Bias toward action** - Ship small improvements rather than waiting for the perfect solution
|
|
- **Self-review is the default** - You know your changes best
|
|
- **Iterate freely** - Don't hesitate to refine existing skills
|
|
|
|
## Testing Skills
|
|
|
|
Before merging, test your changes locally:
|
|
|
|
1. **Install the plugin from your local clone**
|
|
|
|
```bash
|
|
claude plugin marketplace add ~/path/to/sentry-skills
|
|
claude plugin install sentry-skills
|
|
```
|
|
|
|
2. **Restart Claude Code** to pick up changes
|
|
|
|
3. **Invoke the skill** in a relevant context
|
|
|
|
```bash
|
|
# For explicit invocation
|
|
/skill-name
|
|
|
|
# Or describe a task that should trigger the skill
|
|
```
|
|
|
|
4. **Verify behavior** - Check that the skill produces the expected guidance and handles edge cases appropriately
|
|
|
|
## Pull Request Workflow
|
|
|
|
All changes go through the PR flow, but formal review is optional.
|
|
|
|
- **Self-review and merge** when you're confident in your change
|
|
- **Request review** only when you want a second pair of eyes
|
|
- Keep PRs focused - one skill or one improvement per PR when practical
|
|
|
|
## Adding a New Skill
|
|
|
|
1. Create `plugins/sentry-skills/skills/<skill-name>/SKILL.md`
|
|
|
|
2. Add required YAML frontmatter:
|
|
|
|
```yaml
|
|
---
|
|
name: skill-name
|
|
description: What this skill does. Include trigger keywords.
|
|
---
|
|
```
|
|
|
|
3. Update `README.md` to add the skill to the Available Skills table in alphabetical order by skill name
|
|
|
|
4. Add the skill to `.claude/settings.json`:
|
|
|
|
```json
|
|
"Skill(sentry-skills:skill-name)"
|
|
```
|
|
|
|
5. Update the skills allowlist in `plugins/sentry-skills/skills/claude-settings-audit/SKILL.md`
|
|
|
|
See [README.md](README.md) for the full skill template and optional frontmatter fields.
|