Skip to content

Commit 984bfcb

Browse files
Amir-hkrTomKaltofen
authored andcommitted
docs: replace em dashes with plain punctuation
1 parent 8c52570 commit 984bfcb

5 files changed

Lines changed: 16 additions & 16 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If a `placeholder/` directory still exists in this repo, the template has not be
77
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.
88
2. Verify with `uv venv && source .venv/bin/activate && uv sync --all-extras && tox`.
99
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.
1111

1212
Must read [README.md](README.md) first.
1313

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If a `placeholder/` directory still exists in this repo, the template has not be
77
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.
88
2. Verify with `uv venv && source .venv/bin/activate && uv sync --all-extras && tox`.
99
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.
1111

1212
Must read [README.md](README.md) first.
1313

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,28 +102,28 @@ rm CONTRIBUTING.md bin/customize.sh
102102

103103
`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.
104104

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.
106106

107107
The remaining baseline files apply to your plugin out of the box and can be edited to match your conventions:
108108

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.
112112

113113
You may also want to replace this `README.md` with one that describes your plugin.
114114

115115
### Where to next
116116

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.
122122

123123
## Contribute to this template
124124

125125
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:
126126

127127
- [Code of Conduct](CODE_OF_CONDUCT.md)
128-
- [AGENTS.md](AGENTS.md) agent guidance, project practices, issue creation
128+
- [AGENTS.md](AGENTS.md): agent guidance, project practices, issue creation
129129
- [Issue template](.github/ISSUE_TEMPLATE/issue.yml)

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## Supported Versions
88

99
Security fixes are applied to the latest released version and the `main`
10-
branch. We do not backport fixes to older releases — please upgrade to the
10+
branch. We do not backport fixes to older releases. Please upgrade to the
1111
latest version before reporting.
1212

1313
| Version | Supported |
@@ -23,10 +23,10 @@ prepared.
2323

2424
Instead, use one of these private channels:
2525

26-
1. **GitHub Private Vulnerability Reporting** (preferred) open the **Security**
26+
1. **GitHub Private Vulnerability Reporting** (preferred): open the **Security**
2727
tab of this repository and click **Report a vulnerability**. This keeps the
2828
report, discussion, and coordinated disclosure in one place.
29-
2. **Email** for plugins in the mloda organization, write to
29+
2. **Email**: for plugins in the mloda organization, write to
3030
**security@mloda.ai**. If you forked this template, use your own address.
3131

3232
Please include as much of the following as you can:

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ 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 `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
5353
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
5454
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
5555

0 commit comments

Comments
 (0)