docs: add CONTRIBUTING.md and template-only-files strip step - #44
Merged
Conversation
Extends tk-342 with the dual-audience contributor flow: - CONTRIBUTING.md: new file for people improving the template scaffold (setup, toolchain, conventions, PR workflow, plugin-vs-template guidance). It is template-only and travels via the strip step below. - README.md: simplified to one audience (plugin authors). The contributor content moved entirely to CONTRIBUTING.md, which GitHub auto-surfaces on the repo page. This avoids dead links in scaffolded plugin repos after Step 6 runs. - README Setup Your Plugin: new Step 6 removes template-only files (CODE_OF_CONDUCT.md, AGENTS.md, CLAUDE.md, CONTRIBUTING.md, .github/ISSUE_TEMPLATE/) so scaffolded plugin repos start clean. - docs/getting-started.md: extended with the matching strip step.
AGENTS.md/CLAUDE.md describe the same toolchain (tox, ruff, mypy, bandit, Conventional Commits, mloda-registry skills) that scaffolded plugins inherit, and CODE_OF_CONDUCT.md plus .github/ISSUE_TEMPLATE/ are sensible baselines that only need a small edit (contact email, placeholder paths). They are working scaffold content, not template metadata, so Step 6 keeps them. CONTRIBUTING.md is the only file that is genuinely template-only (its subject is "contributing to this template repo"), so it stays in the strip list with optional-edit guidance for the rest. The README regains its dual-audience intro and "Contribute to this template" section pointing to CONTRIBUTING.md, AGENTS.md, CODE_OF_CONDUCT.md, and the issue template, since most of those links now survive Step 6.
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.
Summary
Extends tk-342 with the dual-audience contributor flow. Builds on #43 (Code of Conduct, issue template, AGENTS/CLAUDE Project Practices).
CONTRIBUTING.md(new) — entry point for people improving the template scaffold itself: local setup, toolchain (tox, ruff, mypy, bandit), conventions, PR workflow, plus a "plugin development vs. template contribution" pointer that routes plugin authors to mloda-registry guides instead.README.mdreworked — gains a dual-audience intro and a "Contribute to this template" section (Code of Conduct, AGENTS.md, issue template). The contributor flow lives both in the README (visibility) and inCONTRIBUTING.md(canonical detail).toxpasses, torm CONTRIBUTING.md(the only file that is genuinely template-meta). The remaining baseline files —AGENTS.md/CLAUDE.md(working toolchain doc),CODE_OF_CONDUCT.md,.github/ISSUE_TEMPLATE/— stay as inherited defaults the plugin author can tune. Step 6 calls out the small, optional edits.docs/getting-started.md— gains the matching strip step in its post-creation checklist.Test plan
toxpasses (9 tests, ruff format/check, mypy --strict, bandit)README.md:LICENSE,docs/getting-started.md,docs/github-workflows.md,CODE_OF_CONDUCT.md,AGENTS.md,.github/ISSUE_TEMPLATE/issue.yml— all preserved by Step 6. Two intentional dead links remain post-strip: both referenceCONTRIBUTING.md, which Step 6 itself removes; plugin authors are expected to rewrite the README anyway.CONTRIBUTING.mdshows up in GitHub's "Contributing" auto-surface (Insights → Community Standards) once mergedDecision log