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
根據每個問題的標題與描述內容,從 Sentry 工作區的標籤分類法中分類 Linear 問題,並套用對應的類型標籤。
official
sentry-flutter-sdk
sentry
完整的 Sentry SDK 設定,適用於 Flutter 和 Dart。當被要求「為 Flutter 加入 Sentry」、「安裝 sentry_flutter」、「在 Dart 中設定 Sentry」或設定錯誤…時使用。
official
sentry-svelte-sdk
sentry
完整的 Sentry SDK 設定,適用於 Svelte 和 SvelteKit。當被要求「將 Sentry 加入 Svelte」、「將 Sentry 加入 SvelteKit」、「安裝 @sentry/sveltekit」或進行設定時使用…
official
vercel-react-best-practices
sentry
來自 Vercel Engineering 的 React 與 Next.js 效能優化指南。此技能應在撰寫、審查或重構 React/Next.js… 時使用。
official
sentry-tanstack-start-sdk
sentry
完整的 Sentry SDK 設定,適用於 TanStack Start React。當被要求「將 Sentry 加入 TanStack Start」、「安裝 @sentry/tanstackstart-react」或設定錯誤…時使用。
official