Open
Conversation
Replace TBD placeholder in contributing-md-template.mdx with a full guide modeled on agents-md-template.mdx. Covers the nine standard sections (welcome, setup, workflow, testing, PR submission, code review with LOGAF, AI attribution, help, CoC), lists good examples from five SDK repos, and includes a copyable template. Also adds a .claude/skills/contributing-md/SKILL.md draft for submission to getsentry/sdk-skills — detects ecosystem, fills placeholders from CI config and package manifests, preserves SDK-specific sections, and flags non-standard content with TODOs. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- LOGAF notation: use h:/m:/l: (colon, h-first) to match review-ci standard - LOGAF descriptions: match canonical definitions from review-ci.mdx - Branch naming: <username>/<type>/<short-description> to match code-submission standard - SLAs in "What Belongs": spell out "business day" instead of "BD" - Good Examples: add lead-in sentence matching agents-md-template pattern Co-Authored-By: Claude <noreply@anthropic.com>
- h: fix broken ../../discussions relative link — use placeholder URL - m: fix ecosystem detection: react-native in package.json (not Podfile) to correctly distinguish React Native from sentry-cocoa/iOS repos - m: fix SKILL.md checklist: "table" → "list" to match template - l: commit format wording: "description" → "subject" to match standard Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Co-Authored-By: Claude <noreply@anthropic.com>
Not a universal standard — only used in sentry-cocoa. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- discord.gg/sentry → discord.com/invite/sentry - sentry-cocoa CONTRIBUTING.md master → main - sentry-java CONTRIBUTING.md master → main Co-Authored-By: Claude <noreply@anthropic.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
|
|
||
| Remove sections that don't apply and replace all `[placeholder]` values with real content. | ||
|
|
||
| <CopyableCard title="CONTRIBUTING.md"> |
There was a problem hiding this comment.
Bug: The domToMarkdown function in copyableCard.tsx lacks handlers for heading tags (h1-h6). When copying content with headings, the markdown formatting (#, ##) is lost.
Severity: MEDIUM
Suggested Fix
Update the domToMarkdown function in src/components/copyableCard.tsx to include case statements for heading elements (h1, h2, h3, etc.). These handlers should prepend the corresponding markdown characters (# , ## , ### , etc.) to the node's text content.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: develop-docs/sdk/getting-started/templates/contributing-md-template.mdx#L46
Potential issue: The `domToMarkdown` function in `src/components/copyableCard.tsx`
processes DOM nodes to generate markdown. It has handlers for various tags like `p`,
`li`, and `strong`, but lacks cases for heading tags (`h1` through `h6`). When the new
`CopyableCard` in `contributing-md-template.mdx` is used, its content, which includes
markdown headings, is rendered into HTML heading elements. Clicking "Copy body" triggers
`domToMarkdown`, which falls back to its default case for these unhandled heading tags.
This results in only the text content of the headings being copied, stripping the
essential `#` and `##` markdown prefixes and breaking the document structure.
| 1. Fork the repository and clone your fork. | ||
| 2. \[SDK-specific setup steps — e.g. install language runtime, create virtualenv, etc.\] | ||
| 3. Install dependencies: `[install command]` | ||
| 4. Run tests: `[test command]` |
Contributor
There was a problem hiding this comment.
not necessary to get started
Suggested change
| 4. Run tests: `[test command]` |
Comment on lines
+64
to
+66
| - **Commits:** follow `type(scope): subject` format (e.g. `fix(transport): handle connection timeout`). See the [code submission standard](https://develop.sentry.dev/sdk/getting-started/standards/code-submission/). | ||
| - **Branches:** `<username>/<type>/<short-description>` (e.g. `alice/fix/rate-limit-parsing`) | ||
| - **Changelog:** add an entry under `## Unreleased` in `CHANGELOG.md` for every user-facing change. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Commits:** follow `type(scope): subject` format (e.g. `fix(transport): handle connection timeout`). See the [code submission standard](https://develop.sentry.dev/sdk/getting-started/standards/code-submission/). | |
| - **Branches:** `<username>/<type>/<short-description>` (e.g. `alice/fix/rate-limit-parsing`) | |
| - **Changelog:** add an entry under `## Unreleased` in `CHANGELOG.md` for every user-facing change. | |
| See our [principles](https://develop.sentry.dev/sdk/getting-started/principles/) and [standards](https://develop.sentry.dev/sdk/getting-started/standards/) for SDK development. |
| - `m:` (medium) — should fix: design, missing tests, clarity | ||
| - `l:` (low) — optional nit: style, minor suggestions | ||
|
|
||
| Expected SLAs: **1 business day** for Sentry engineers, **2 business days** for external contributors. |
Contributor
There was a problem hiding this comment.
Would not put that in that file
Suggested change
| Expected SLAs: **1 business day** for Sentry engineers, **2 business days** for external contributors. |
Contributor
stephanie-anderson
left a comment
stephanie-anderson
left a comment
There was a problem hiding this comment.
I'm not sure if we should be referencing playbooks for our own teams (like reviewing external contrib PRs etc). THe CONTRIBUTING.md is meant for external contributors to read to understand the rules, not necessarily our own folks. We can clarify that in the intro if you think that makes sense, and can additionally link to the develop docs, so potential candidates / hires can read what is important to us. But for community members this could be perceived as noise
Contributor
stephanie-anderson
left a comment
stephanie-anderson
left a comment
There was a problem hiding this comment.
Ah, one more thing! Could you please move the file from /sdk/getting-started/templates/contributing-md-template/ to /sdk/getting-started/templates/contributing-md/ and add a redirect? template is already in the URL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the TBD placeholder in contributing-md-template.mdx with a full guide: what belongs in a CONTRIBUTING.md, good examples from 5 SDK repos, and a copyable template covering setup, workflow, testing, PR submission, code review (LOGAF), AI attribution, and getting help.
IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com