Add README.md following DPC conventions - #10
Conversation
Adds the repository landing page that was missing, using the section structure applied by aligned sibling DPC plugins: Description, Installation, Usage, Support, Contributing, Testing, Development, Authors and Acknowledgement, License and Project Status. The Testing and Development sections describe this repository as it actually stands: no test suite, no build system, a checkout-only Build workflow that verifies nothing, manual javac/jar packaging steps, and an on-server validation checklist. No bStats section is included because no bStats integration exists in the source. Closes #4 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- Describe the linked Discord as the Dans Plugins Community server, which is what it demonstrably is across sibling DPC repositories, rather than asserting a FlyCommand-specific support server that is not verifiable from this repository. - Note that the jar must be compiled at a release level the target server's Java runtime can load, since the manual javac steps otherwise produce class files a 1.13 era server rejects. - Record the new README under [Unreleased] in CHANGELOG.md. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Self-reviewPerformed on the PR head ( Findings raised and fixed
Rubric
Repo-specific rubric
Merge readinessNo path in this diff matches the do-not-auto-merge list — The green This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
Summary
README.mdis added. The repository previously had none, so its GitHub landing page showed nothing at all.Dans-Plugins/NoMoreCreepers: Description, Installation, Usage (with links to the existing documentation files), Support, Contributing, Testing, Development, Authors and Acknowledgement, License, Project Status.Buildworkflow checks the repository out and does nothing further — so a green check confirms only that the repository could be cloned. It compiles nothing and runs nothing.javac/jarpackaging steps that stand in for a build tool, and an on-server validation checklist.Main.javaimports onlyorg.bukkit.*types).Validation
The mechanical consistency checks were run on the PR head, and their output is recorded below.
grep -n '^main:' plugin.ymlmain: me.Daniel.FlyCommand.Maingrep -n '^package ' me/Daniel/FlyCommand/Main.javapackage me.Daniel.FlyCommand;grep -n 'public class ' me/Daniel/FlyCommand/Main.javapublic class Main extends JavaPlugin {grep -n 'equalsIgnoreCase(' me/Daniel/FlyCommand/Main.javalabel.equalsIgnoreCase("fly")grep -n -A5 '^commands:' plugin.ymlcommands:/Fly:python3 -c "import yaml; yaml.safe_load(open('plugin.yml'))"{'main': 'me.Daniel.FlyCommand.Main', 'name': 'FlyCommand', 'version': 1.0, 'api-version': 1.13, 'commands': {'Fly': None}}main:equals<package>.<class>and matches the file's path on disk. The handled labelflyhas a manifest key (Fly; Bukkit lowercases labels when registering, and the source comparison is case-insensitive).One check reports a pre-existing disagreement that this PR does not introduce and does not fix:
hasPermission("FlyCommand.fly")appears inUSER_GUIDE.md,COMMANDS.mdand nowREADME.md, but is still absent fromplugin.yml. That gap is tracked separately in #5 and is deliberately left for an implementation cycle rather than being smuggled into a documentation change.No Java behaviour is changed by this PR, so no on-server reproduction recipe is required for the diff itself. Rendering of the new file should be eyeballed on GitHub, and the relative links (
USER_GUIDE.md,COMMANDS.md,CONFIG.md,CHANGELOG.md,CONTRIBUTING.md,LICENSE,.github/workflows/build.yml) confirmed to resolve — all seven targets exist in the tree.Note on CI
The green
Buildcheck on this pull request is not verification of anything..github/workflows/build.ymlcontains a singleactions/checkout@v4step and zerorun:steps, so it cannot fail on anything in a diff. This gap is tracked in #9.Backlog deferred this cycle
Issues filed during triage but not selected, with the reason each was deferred:
plugin.ymldeclares no permissions block and no command metadata) — deferred because it edits the load-time manifest, which nothing in this repository can validate; it also carries an open design decision about whether a command-levelpermission:key should replace the plugin's own alert message. It belongs in an implementation cycle with a server available.return false) — behavioural Java, unverifiable without a server; deliberately excluded from a documentation-only change.onCommandmissing@Override) — a source change with no compiler available to confirm it; excluded for the same reason.Closes #4
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson