Skip to content

Commit af7f323

Browse files
committed
docs: only strip CONTRIBUTING.md, restore contributor section
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.
1 parent 70f68c4 commit af7f323

2 files changed

Lines changed: 23 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66

77
> **A GitHub template for creating standalone mloda plugins.** Part of the [mloda](https://github.com/mloda-ai/mloda) ecosystem for open data access. Visit [mloda.ai](https://mloda.ai) for an overview and business context, the [GitHub repository](https://github.com/mloda-ai/mloda) for technical context, or the [documentation](https://mloda-ai.github.io/mloda/) for detailed guides.
88
9-
Create your own FeatureGroups, ComputeFrameworks, and Extenders as standalone packages.
9+
Create your own FeatureGroups, ComputeFrameworks, and Extenders as standalone packages. This repository serves two audiences:
10+
11+
- **Plugin authors**: click *Use this template* on GitHub to scaffold a new plugin repository, then follow the [Use this template](#use-this-template) section below.
12+
- **Template contributors**: improving the scaffold itself? See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Contribute to this template](#contribute-to-this-template) section.
1013

1114
## Related Repositories
1215

@@ -86,20 +89,33 @@ Update imports in these files (change `from placeholder.` to `from acme.`):
8689
uv venv && source .venv/bin/activate && uv sync --all-extras && tox
8790
```
8891

89-
#### 6. Remove template-only files
92+
#### 6. Remove the template-only contributor guide
9093

91-
These files belong to the template repo and don't apply to your scaffolded plugin. Remove them after `tox` passes:
94+
`CONTRIBUTING.md` describes how to contribute to the template repo itself; it does not apply to your plugin. Remove it after `tox` passes:
9295

9396
```bash
94-
rm CODE_OF_CONDUCT.md AGENTS.md CLAUDE.md CONTRIBUTING.md
95-
rm -rf .github/ISSUE_TEMPLATE/
97+
rm CONTRIBUTING.md
9698
```
9799

98-
You may also want to replace this `README.md` with one that describes your plugin. Add your own Code of Conduct, contributor guide, and issue templates later if you want them.
100+
The remaining baseline files apply to your plugin out of the box and can be edited to match your conventions:
101+
102+
- `AGENTS.md` and `CLAUDE.md` — toolchain and project practices for the same `tox`/ruff/mypy/bandit pipeline you inherit. Tune the bullets if you change the toolchain.
103+
- `CODE_OF_CONDUCT.md` — short, plain-English baseline. Update the contact (`conduct@mloda.ai` → your address) if you want enforcement to come to you.
104+
- `.github/ISSUE_TEMPLATE/issue.yml` — unified issue form. Update the placeholder file paths to point at your renamed package.
105+
106+
You may also want to replace this `README.md` with one that describes your plugin.
99107

100108
### Where to next
101109

102110
- **[mloda-registry/docs/guides/](https://github.com/mloda-ai/mloda-registry/tree/main/docs/guides/)** — full plugin development walkthrough (FeatureGroups, ComputeFrameworks, Extenders, packaging, publishing).
103111
- **[mloda](https://github.com/mloda-ai/mloda)** — core framework reference.
104112
- **[Claude Code skills](https://github.com/mloda-ai/mloda-registry/tree/main/.claude/skills/)** — pattern guidance and best practices for AI-assisted plugin development.
105113
- **[docs/github-workflows.md](docs/github-workflows.md)** — CI/CD setup and required secrets for the included workflows.
114+
115+
## Contribute to this template
116+
117+
This section is for people improving the scaffold itself (CI workflows, dev tooling, docs, examples). See [CONTRIBUTING.md](CONTRIBUTING.md) for the full contributor guide. Quick pointers:
118+
119+
- [Code of Conduct](CODE_OF_CONDUCT.md)
120+
- [AGENTS.md](AGENTS.md) — agent guidance, project practices, issue creation
121+
- [Issue template](.github/ISSUE_TEMPLATE/issue.yml)

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ Regardless of which option you chose, follow the setup steps in the [README](../
4949
4. Update `.releaserc.yaml` (change `mloda-plugin-template` to your package name and update `repositoryUrl`)
5050
5. Update Python imports
5151
6. Verify with `tox`
52-
7. Remove template-only community files (`CODE_OF_CONDUCT.md`, `AGENTS.md`, `CLAUDE.md`, `CONTRIBUTING.md`, `.github/ISSUE_TEMPLATE/`) — they apply to the template repo, not to your plugin
52+
7. Remove `CONTRIBUTING.md` (the template's own contributor guide doesn't apply to your plugin); optionally tune `CODE_OF_CONDUCT.md`, `AGENTS.md`/`CLAUDE.md`, and `.github/ISSUE_TEMPLATE/` to fit your plugin

0 commit comments

Comments
 (0)