Skip to content

code-submission.mdx

Latest commit

 

History

History
238 lines (141 loc) · 5.69 KB

code-submission.mdx

File metadata and controls

238 lines (141 loc) · 5.69 KB
title Code Submission
spec_id sdk/getting-started/standards/code-submission
spec_version 1.1.0
spec_status candidate
spec_platforms
all
spec_changelog
version date summary
1.1.0
2026-03-04
Add username prefix and type descriptions to branch naming
version date summary
1.0.0
2026-02-18
Initial Code Submission standard
sidebar_order 2

Commit message format

Rule

<type>(<scope>): <subject>

<body>

<footer>

Header (max 100 chars total):

  • Type: one of:
    • feat – New user-facing functionality
    • fix – Broken behavior now works
    • ref – Same behavior, different structure
    • perf – Same behavior, faster
    • style – CSS, formatting, visual-only
    • docs – Documentation only
    • test – Tests only
    • ci – CI/CD config
    • build – Build system
    • chore – Deps, config, version bumps, updating existing tooling — no new logic
    • meta – Repo metadata changes
    • license – License changes
  • Subject: imperative mood, capitalize first letter, no trailing period, max 70 chars

Body: explain what and why, not how.

Footer (one or more of):

  • Issue references: Fixes SENTRY-1234, Fixes GH-1234, Refs LINEAR-ABC-123
  • Breaking change notices: BREAKING CHANGE:
  • AI attribution (see AI attribution)

For additional context on commit message best practices, see Commit Messages.

Enforcement

Suggested skill(s)

Per-SDK override

Scope values are SDK-specific.

Branch naming

Rule

<username>/<type>/<short-description> (e.g., theo/feat/add-client-reports, alice/fix/rate-limit-parsing).

  • username: GitHub username (e.g., from gh api user --jq .login)
  • type: same types as commit messages
  • short-description: overview of the change, in kebab-case

Enforcement

  • CI advisory (non-blocking)

Suggested skill(s)

Per-SDK override

PR description quality

Rule

Every PR MUST include a description with:

  • What the PR does
  • Why these changes are being made
  • Links to relevant issues or tickets (REQUIRED except for typo fixes and one-line doc changes)
  • Alternative approaches considered (if any)
  • Additional context reviewers need

Test plan sections, checkbox lists, and boilerplate are not allowed. The tests in the diff serve as the test plan. Blank descriptions, template-only descriptions, and AI-generated filler are not acceptable. PR descriptions MUST NOT include any customer data or sensitive information.

Enforcement

  • PR template
  • CI bot check: non-empty, issue reference present, override via trivial label

Suggested skill(s)

Per-SDK override

Template wording can vary. Linked-issue and non-empty requirements are universal.

PR draft mode

Rule

PRs MUST be created as drafts. Mark ready when CI passes and description is complete.

Enforcement

  • Convention
  • AGENTS.md

Suggested skill(s)

Per-SDK override

Changelog entry

Rule

User-facing changes (feat, fix, perf, breaking) REQUIRE a changelog entry. Internal changes exempt. Override with skip-changelog label.

Enforcement

  • CI check

Per-SDK override

Format and location vary. Requirement is universal.

Keep PRs focused

Rule

A PR SHOULD do one thing — and do it well. Avoid mixing functional changes with unrelated refactors, cleanup, or reorganizations. If the work falls into distinct categories, split it into multiple PRs. Smaller, focused PRs are easier to review, reason about, and revert.

Enforcement

  • Human review + AGENTS.md
  • CI advisory for size

Suggested skill(s)

Per-SDK override

Size thresholds are SDK-specific.

AI attribution

Rule

AI-generated changes get Co-Authored-By in commit footer (e.g., Co-Authored-By: Claude <noreply@anthropic.com>). This is the only AI involvement indicator. "Generated by AI" or similar markers MUST NOT appear anywhere.

Enforcement

  • AGENTS.md instruction

Suggested skill(s)

Per-SDK override

Changelog