contributing-md
CONTRIBUTING.md eines Sentry SDK-Repositorys generieren oder an die Standardvorlage anpassen. Die Einhaltung der Spezifikation hat oberste Priorität; SDK-spezifische Inhalte werden erhalten oder ergänzt. Ziel sind 100–200 Zeilen – detaillierte Prozesse befinden sich auf develop.sentry.dev, dorthin verlinken, nicht duplizieren.
npx skills add https://github.com/getsentry/sdk-skills --skill contributing-mdContributing.md Skill
Generate or align a Sentry SDK repository's CONTRIBUTING.md with the
standard template.
Spec compliance is the primary goal; SDK-specific content is preserved or added around it.
Target 100–200 lines — detailed process lives on develop.sentry.dev, link there, don't duplicate.
Steps
1. Fetch the template
https://develop.sentry.dev/sdk/getting-started/templates/contributing-md-template/
This is the source of truth for required sections, structure, and links.
2. Read the existing file (if any)
If CONTRIBUTING.md exists, read it. Commands and SDK-specific content already there
should be trusted. If it does not exist, use the fetched template as the starting point.
3. Find commands from the repo
For missing or placeholder values, read in priority order:
.github/workflows/*.yml— authoritative test/lint/build commandsMakefile/Taskfile.yml/tox.ini— command wrappersREADME.md— install command, SDK namedocs.sentry.iofor the SDK — setup steps if not found above
4. Reference good examples
Check these repos for structural inspiration if needed:
sentry-python— integration principles, user vs contributor setupsentry-javascript— Volta pin, monorepo workflow, draft PR rulesentry-go— LOGAF usage, craft release-notes requirementsentry-cocoa— LOGAF with descriptions, copyright header rulesentry-java— API compatibility workflow, step-by-step setup
5. Write the file
- Follow the section order from the fetched template
- Append preserved SDK-specific sections after standard content
- Flag contradictions rather than removing:
<!-- TODO: review against standard: https://develop.sentry.dev/... --> - If file would exceed 200 lines, move verbose steps to a linked doc and reference it
6. Verify
Grep for \[ — no unreplaced placeholder tokens should remain.
Quality Checklist
- All
[placeholder]values replaced with real content - Commands verified against CI config or README
- Existing SDK-specific sections preserved
- Non-standard content flagged with TODO comments
- AI attribution section present
- File is 100–200 lines
- No links point to Notion or Linear