Skip to content

docs(contributing): update CONTRIBUTING.md and README.md with accurate content#2242

Open
dancormier wants to merge 1 commit intomainfrom
dcormier/contributing-merge-guardrails
Open

docs(contributing): update CONTRIBUTING.md and README.md with accurate content#2242
dancormier wants to merge 1 commit intomainfrom
dcormier/contributing-merge-guardrails

Conversation

@dancormier
Copy link
Copy Markdown
Contributor

@dancormier dancormier commented Apr 21, 2026

Closes STACKS-853

Summary

CONTRIBUTING.md and README.md were out of date and missing important process documentation. This PR brings both up to date:

  • Merge guardrails: New section covering required PR approvals, no self-merging, and understanding downstream impact before deploying
  • Issue routing: "Open an issue" renamed to "Before you start" and split by audience — internal staff use Jira/the Stacks Issue Intake form, external contributors use GitHub Issues
  • Changesets: New section explaining when and how to add a changeset as part of a PR
  • PR workflow: Internal and external contributor steps split into separate subheadings for clarity; added draft PR guidance
  • Code guidelines: Removed rules that tools enforce automatically; added TypeScript, Svelte, and JavaScript sections; removed sections we don't reliably follow; added links to relevant ADRs and accessibility docs
  • Accuracy fixes: Broken CI badge, wrong workflow file references, incorrect changeset base branch, `develop` → `main` throughout, commit message format updated to reference Conventional Commits, copyright year updated
  • README structure: Contributing section moved near the top; heading levels normalized; redundant sections removed

🤖 Generated with Claude Code

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 21, 2026

Deploy Preview for stacks failed. Why did it fail? →

Name Link
🔨 Latest commit 5fd4c89
🔍 Latest deploy log https://app.netlify.com/projects/stacks/deploys/69e7f0da58e3f40008db58d0

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 21, 2026

⚠️ No Changeset found

Latest commit: 5fd4c89

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dancormier dancormier force-pushed the dcormier/contributing-merge-guardrails branch 8 times, most recently from 40e4847 to bd672e3 Compare April 21, 2026 21:47
…e content

- Add Merge requirements section formalizing PR approval and self-merge rules
- Add TypeScript and Svelte subsections to code guidelines
- Rename "Open an issue" to "Before you start"; route internal staff to
  Jira/intake form and external contributors to GitHub Issues
- Fix commit message guidelines to reference Conventional Commits
- Fix git pull --rebase step to split internal/external like steps 1 and 2
- Fix reproducable typo
- Normalize README heading levels (H1 → H2 throughout)
- Move Contributing section before Local Development in README
- Remove redundant Bugs and feature requests section from README
- Fix setup troubleshooting link to use contributing guide routing

Jira: STACKS-853

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@dancormier dancormier force-pushed the dcormier/contributing-merge-guardrails branch from bd672e3 to 5fd4c89 Compare April 21, 2026 21:49
@dancormier dancormier marked this pull request as ready for review April 21, 2026 21:55
@dancormier dancormier requested review from a team and abovedave April 21, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant