agentleFS
Sign inStart free
SentryKnown publishergetsentry/sdk-skills/plugins/sentry-sdk-skills/skills/contributing-md/SKILL.md

contributing-md

Skill4 starsChanged 10 months agoApache-2.0View on GitHub

Generate or align a CONTRIBUTING.md for a Sentry SDK repository with the develop.sentry.dev standard template. Use when asked to "create contributing.md", "update contributing.md", "align contributing docs", "standardize contributor docs", or when the contributing guide is outdated, missing sections, or does not exist.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If CONTRIBUTING.md exists, read it.

    line 29
  2. Distinctive:

    Check these repos for structural inspiration if needed:

    line 43
  3. Distinctive:

    Follow the section order from the fetched template

    line 53
  4. Distinctive:

    If file would exceed 200 lines, move verbose steps to a linked doc and reference it

    line 59

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free