docs: add CONTRIBUTING.md#58
Open
YAMRAJ13y wants to merge 1 commit into
Open
Conversation
The repo attracts external PRs but has no contributor guide, so newcomers miss two repo-specific things: (1) this is a template — website clones shouldn't be PR'd here — and (2) the AGENTS.md / SKILL.md source-of-truth files have generated platform copies that must be regenerated with the sync scripts. Adds a concise CONTRIBUTING.md covering ways to contribute, dev setup (Node 24+, npm run check), the sync-script workflow, and PR conventions (Conventional Commits, link the issue, fill the template). Grounded in the repo's existing README and AGENTS.md guidance. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Adds a
CONTRIBUTING.md— the repo currently has none, despite getting a steady stream of external PRs. New contributors miss two repo-specific things that this guide makes explicit:AGENTS.mdand.claude/skills/clone-website/SKILL.mdare the only files you edit; their platform copies are generated byscripts/sync-agent-rules.sh/scripts/sync-skills.mjsand must be regenerated and committed.It also documents dev setup (Node 24+,
npm run check), PR conventions (Conventional Commits, link the issue, fill the PR template), and points questions to the Discord.Related Issue
None — fills a community-health gap.
Type of Change
Notes
README.md,AGENTS.md, PR template, and commit conventions — no new policy invented.🤖 Generated with Claude Code