contributing-md

作者: sentry

生成或对齐 Sentry SDK 仓库的 CONTRIBUTING.md 文件,使其符合标准模板。主要目标是确保规范合规;围绕模板保留或添加 SDK 特有的内容。目标行数为 100–200 行——详细流程位于 develop.sentry.dev,请链接至该处,不要重复内容。

npx skills add https://github.com/getsentry/sdk-skills --skill contributing-md

Contributing.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:

  1. .github/workflows/*.yml — authoritative test/lint/build commands
  2. Makefile / Taskfile.yml / tox.ini — command wrappers
  3. README.md — install command, SDK name
  4. docs.sentry.io for 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 setup
  • sentry-javascript — Volta pin, monorepo workflow, draft PR rule
  • sentry-go — LOGAF usage, craft release-notes requirement
  • sentry-cocoa — LOGAF with descriptions, copyright header rule
  • sentry-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

来自 sentry 的更多技能

generate-frontend-forms
sentry
使用Sentry新表单系统创建表单的指南。在实现表单、表单字段、验证或自动保存功能时使用。
official
sentry-snapshots-cocoa
sentry
完整的 Sentry Snapshots 配置,适用于 Apple/Cocoa 项目。当被要求“设置 SnapshotPreviews”、“设置 Apple 快照测试”、“上传 Apple 快照到…”时使用。
official
architecture-review
sentry
员工级代码库健康审查。发现单体模块、静默失败、类型安全漏洞、测试覆盖缺口以及LLM友好性问题。
official
linear-type-labeler
sentry
根据每个问题的标题和描述内容,对Linear问题进行分类,并从Sentry工作区的标签分类体系中应用一个类型标签。
official
sentry-flutter-sdk
sentry
完整的Sentry SDK配置,适用于Flutter和Dart。当被要求“为Flutter添加Sentry”、“安装sentry_flutter”、“在Dart中配置Sentry”或配置错误…时使用。
official
sentry-svelte-sdk
sentry
为Svelte和SvelteKit提供完整的Sentry SDK设置。当被要求“为Svelte添加Sentry”、“为SvelteKit添加Sentry”、“安装@sentry/sveltekit”或配置……时使用。
official
vercel-react-best-practices
sentry
来自 Vercel 工程团队的 React 和 Next.js 性能优化指南。在编写、审查或重构 React/Next.js… 时应使用此技能。
official
sentry-tanstack-start-sdk
sentry
为TanStack Start React提供完整的Sentry SDK设置。当被要求“向TanStack Start添加Sentry”、“安装@sentry/tanstackstart-react”或配置错误…时使用。
official