Skip to content

docs: add CONTRIBUTING.md#58

Open
YAMRAJ13y wants to merge 1 commit into
JCodesMore:masterfrom
YAMRAJ13y:docs/add-contributing-guide
Open

docs: add CONTRIBUTING.md#58
YAMRAJ13y wants to merge 1 commit into
JCodesMore:masterfrom
YAMRAJ13y:docs/add-contributing-guide

Conversation

@YAMRAJ13y

@YAMRAJ13y YAMRAJ13y commented Jun 24, 2026

Copy link
Copy Markdown

There's no contributor guide in the repo yet, even though it gets a fair number of outside PRs. A couple of repo-specific things are easy to miss without one:

  • This is a template — people sometimes open PRs here with their generated website instead of using "Use this template" to make their own copy.
  • AGENTS.md and the clone-website SKILL.md are the source of truth; their per-platform copies are generated and have to be regenerated with the sync scripts.

This adds a short CONTRIBUTING.md covering ways to help, dev setup (Node 24+, npm run check), the sync workflow, and the basic PR conventions. It doesn't introduce any new policy — it just writes down what's already in the README and AGENTS.md.

There's no contributor guide yet, so a couple of repo-specific things are
easy to miss: this is a template (so generated websites shouldn't be PR'd
here), and AGENTS.md / the clone-website SKILL.md are the source of truth -
their platform copies are generated and need to be regenerated with the
sync scripts.

Adds a short CONTRIBUTING.md covering ways to help, dev setup, the sync
workflow, and PR conventions. Nothing new invented - it just writes down
what's already in the README and AGENTS.md.
@YAMRAJ13y
YAMRAJ13y force-pushed the docs/add-contributing-guide branch from cd23749 to 5cfb14f Compare June 30, 2026 04:52
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