Skip to content

Commit c9a755a

Browse files
author
arch
authored
docs(skill): genericize run-example-plugin Skill (#383)
1 parent 43f5c54 commit c9a755a

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

.claude/skills/run-example-plugin/SKILL.md renamed to .claude/skills/run-plugin/SKILL.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: run-example-plugin
3-
description: Build, test, and release ExamplePlugin (this PaperMC/Spigot plugin template) from source. Use when asked to build the plugin, run its tests, run a single test class, or produce a release JAR.
2+
name: run-plugin
3+
description: Build, test, and release this PaperMC/Spigot plugin from source. Use when asked to build the plugin, run its tests, run a single test class, or produce a release JAR.
44
---
55

6-
`ExamplePlugin` is a PaperMC/Spigot plugin — "running" it means building from source,
7-
executing the test suite, and optionally producing the shaded JAR that gets dropped into a
8-
server's `plugins/` folder.
6+
This is a PaperMC/Spigot plugin — "running" it means building from source, executing the test
7+
suite, and optionally producing the shaded JAR that gets dropped into a server's `plugins/`
8+
folder.
99

1010
## Build
1111

@@ -26,20 +26,20 @@ and all tests. Fix every warning — the build fails on the first one.
2626
All tests pass. Subset by class:
2727

2828
```bash
29-
./gradlew test --tests "com.crimsonwarpedcraft.exampleplugin.command.PingTest"
29+
./gradlew test --tests "com.example.plugin.command.PingTest"
3030
```
3131

3232
Subset by method:
3333

3434
```bash
35-
./gradlew test --tests "com.crimsonwarpedcraft.exampleplugin.command.GreetTest.greetsTarget"
35+
./gradlew test --tests "com.example.plugin.command.GreetTest.greetsTarget"
3636
```
3737

3838
## Release JAR
3939

4040
```bash
4141
./gradlew -Pver="v1.0.0" release
42-
# → build/libs/ExamplePlugin.jar (version stripped from filename for stable tags)
42+
# → build/libs/<project-name>.jar (version stripped from filename for stable tags)
4343
```
4444

4545
Versioning logic (`build.gradle.kts`):
@@ -61,7 +61,7 @@ Keep these in sync with the current state of the project:
6161
- **`CLAUDE.md`** — architecture, versioning logic, customization checklist
6262
- **`README.md`**, **`docs/usage.md`**, **`docs/customization.md`**, **`docs/releases.md`**
6363
feature list, extension recipes, fork checklist, PaperMC version mapping
64-
- **`.claude/skills/run-example-plugin/SKILL.md`** (this file) — build commands, release
64+
- **`.claude/skills/run-plugin/SKILL.md`** (this file) — build commands, release
6565
process, shaded package list
6666

6767
## Gotchas

0 commit comments

Comments
 (0)