|
6 | 6 |
|
7 | 7 | > **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. |
8 | 8 |
|
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. |
10 | 13 |
|
11 | 14 | ## Related Repositories |
12 | 15 |
|
@@ -86,20 +89,33 @@ Update imports in these files (change `from placeholder.` to `from acme.`): |
86 | 89 | uv venv && source .venv/bin/activate && uv sync --all-extras && tox |
87 | 90 | ``` |
88 | 91 |
|
89 | | -#### 6. Remove template-only files |
| 92 | +#### 6. Remove the template-only contributor guide |
90 | 93 |
|
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: |
92 | 95 |
|
93 | 96 | ```bash |
94 | | -rm CODE_OF_CONDUCT.md AGENTS.md CLAUDE.md CONTRIBUTING.md |
95 | | -rm -rf .github/ISSUE_TEMPLATE/ |
| 97 | +rm CONTRIBUTING.md |
96 | 98 | ``` |
97 | 99 |
|
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. |
99 | 107 |
|
100 | 108 | ### Where to next |
101 | 109 |
|
102 | 110 | - **[mloda-registry/docs/guides/](https://github.com/mloda-ai/mloda-registry/tree/main/docs/guides/)** — full plugin development walkthrough (FeatureGroups, ComputeFrameworks, Extenders, packaging, publishing). |
103 | 111 | - **[mloda](https://github.com/mloda-ai/mloda)** — core framework reference. |
104 | 112 | - **[Claude Code skills](https://github.com/mloda-ai/mloda-registry/tree/main/.claude/skills/)** — pattern guidance and best practices for AI-assisted plugin development. |
105 | 113 | - **[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) |
0 commit comments