You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ If a `placeholder/` directory still exists in this repo, the template has not be
7
7
1. Run `bin/customize.sh <package-name>` with appropriate `--author`, `--email`, `--description`, and `--repository-url` flags (see `### Setup Your Plugin` in [README.md](README.md) for details). This handles the directory rename, `pyproject.toml`/`.releaserc.yaml` edits, and `from placeholder.` import rewrites in one shot.
3. Remove the template-only files: `rm CONTRIBUTING.md bin/customize.sh`.
10
-
4.**Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`** — it only applies to fresh-template repos and would be misleading once the placeholder is gone.
10
+
4.4.**Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`**. It only applies to fresh-template repos and would be misleading once the placeholder is gone. gone.
Copy file name to clipboardExpand all lines: CLAUDE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ If a `placeholder/` directory still exists in this repo, the template has not be
7
7
1. Run `bin/customize.sh <package-name>` with appropriate `--author`, `--email`, `--description`, and `--repository-url` flags (see `### Setup Your Plugin` in [README.md](README.md) for details). This handles the directory rename, `pyproject.toml`/`.releaserc.yaml` edits, and `from placeholder.` import rewrites in one shot.
3. Remove the template-only files: `rm CONTRIBUTING.md bin/customize.sh`.
10
-
4.**Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`** — it only applies to fresh-template repos and would be misleading once the placeholder is gone.
10
+
4.**Delete this `## First-time setup` section from both `CLAUDE.md` and `AGENTS.md`**. It only applies to fresh-template repos and would be misleading once the placeholder is gone.
`CONTRIBUTING.md` describes how to contribute to the template repo; `bin/customize.sh` is a one-shot scaffold script that has nothing left to do.
104
104
105
-
Also delete the `## First-time setup` section from `CLAUDE.md` and `AGENTS.md` — those instructions only apply to fresh-template repos.
105
+
Also delete the `## First-time setup` section from `CLAUDE.md` and `AGENTS.md`. Those instructions only apply to fresh-template repos.
106
106
107
107
The remaining baseline files apply to your plugin out of the box and can be edited to match your conventions:
108
108
109
-
-`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.
110
-
-`CODE_OF_CONDUCT.md` — short, plain-English baseline. Update the contact (`conduct@mloda.ai` → your address) if you want enforcement to come to you.
111
-
-`.github/ISSUE_TEMPLATE/issue.yml` — unified issue form. Update the placeholder file paths to point at your renamed package.
109
+
-`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.
110
+
-`CODE_OF_CONDUCT.md`: short, plain-English baseline. Update the contact (`conduct@mloda.ai` → your address) if you want enforcement to come to you.
111
+
-`.github/ISSUE_TEMPLATE/issue.yml`: unified issue form. Update the placeholder file paths to point at your renamed package.
112
112
113
113
You may also want to replace this `README.md` with one that describes your plugin.
114
114
115
115
### Where to next
116
116
117
-
-**[mloda-registry/docs/guides/](https://github.com/mloda-ai/mloda-registry/tree/main/docs/guides/)** — full plugin development walkthrough (FeatureGroups, ComputeFrameworks, Extenders, packaging, publishing).
118
-
-**[mloda](https://github.com/mloda-ai/mloda)** — core framework reference.
119
-
-**[Claude Code skills](https://github.com/mloda-ai/mloda-registry/tree/main/.claude/skills/)** — pattern guidance and best practices for AI-assisted plugin development.
120
-
-**[docs/github-workflows.md](docs/github-workflows.md)** — CI/CD setup and required secrets for the included workflows.
121
-
-**[docs/github-repository-settings.md](docs/github-repository-settings.md)** — repository-side settings (secrets, branch protection, required checks, dependabot reviewer) you should configure after scaffolding.
117
+
-**[mloda-registry/docs/guides/](https://github.com/mloda-ai/mloda-registry/tree/main/docs/guides/)**: full plugin development walkthrough (FeatureGroups, ComputeFrameworks, Extenders, packaging, publishing).
118
+
-**[mloda](https://github.com/mloda-ai/mloda)**: core framework reference.
119
+
-**[Claude Code skills](https://github.com/mloda-ai/mloda-registry/tree/main/.claude/skills/)**: pattern guidance and best practices for AI-assisted plugin development.
120
+
-**[docs/github-workflows.md](docs/github-workflows.md)**: CI/CD setup and required secrets for the included workflows.
121
+
-**[docs/github-repository-settings.md](docs/github-repository-settings.md)**: repository-side settings (secrets, branch protection, required checks, dependabot reviewer) you should configure after scaffolding.
122
122
123
123
## Contribute to this template
124
124
125
125
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:
Copy file name to clipboardExpand all lines: docs/getting-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ Regardless of which option you chose, follow the setup steps in the [README](../
49
49
4. Update `.releaserc.yaml` (change `mloda-plugin-template` to your package name and update `repositoryUrl`)
50
50
5. Update Python imports
51
51
6. Verify with `tox`
52
-
7. Remove `CONTRIBUTING.md` — it describes contributing to the template repo, not your plugin
52
+
7. Remove `CONTRIBUTING.md`. it describes contributing to the template repo, not your plugin
53
53
8. Keep `CODE_OF_CONDUCT.md`, `AGENTS.md`, `CLAUDE.md`, and `.github/ISSUE_TEMPLATE/` as inherited baselines; tune them later (contact email, placeholder paths, toolchain bullets) if you want
54
54
9. Configure repository settings on GitHub: see [github-repository-settings.md](github-repository-settings.md) for the secrets, branch protection, required checks, and dependabot reviewer that the inherited workflows expect
0 commit comments