Skip to content

Add issue templates, CODEOWNERS, and commit/PR conventions - #90

Merged
dmccoystephenson merged 3 commits into
mainfrom
chore/dms-conventions-alignment
Aug 9, 2026
Merged

Add issue templates, CODEOWNERS, and commit/PR conventions#90
dmccoystephenson merged 3 commits into
mainfrom
chore/dms-conventions-alignment

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Three of the four artifact gaps recorded in #89 are closed here, along with that issue's README.md nit.

Two claims from the #89 audit were re-verified against the full history before being written down, since that audit ran against a shallow clone:

Not in this pull request

#89 is therefore referenced rather than closed, and a comment enumerating what remains will be left on it.

Test plan

  • No Java source, plugin.yml, config.yml, migration, or build.gradle file is touched — the change is Markdown documentation and GitHub repository metadata only.
  • The Build workflow passes on this pull request's head. It is the external anchor here; note that its scope does not extend to the changed files, none of which are compiled or executed.
  • Manual verification after merge: opening a new issue offers both templates, and the applied labels match the bracketed title tags.
  • Manual verification after merge: the maintainer is auto-requested as reviewer on the next pull request.

Part of #89.

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

dmccoystephenson and others added 3 commits August 9, 2026 05:39
Record the branch prefixes, imperative commit style, squash-merge default,
Closes #N linking and AI co-author trailer already in use, and point the
bug-report links at the template chooser.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Add bug-report and feature-request templates carrying the environment
dimensions this plugin actually varies over, plus a redaction reminder for
IP addresses, and assign review of every path to the maintainer.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
CHANGELOG.md currently has no [Unreleased] section, so pointing at one
without saying to create it left the instruction unfollowable.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric, scored against the diff and command output rather than judgment:

  • Scope: PASSgit diff --name-only origin/main...HEAD lists exactly CONTRIBUTING.md, README.md, .github/CODEOWNERS, .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md. Each maps to an item in Align repository with dms-conventions (CLAUDE.md, issue templates, CODEOWNERS, commit/PR conventions) #89's "Requested work". No unrelated formatting or renames are present.
  • Tests-new: N/A — no public method or function is added; the diff contains no Java.
  • Tests-fix: N/A — no bug fix is present, so the stash-and-run check has nothing to exercise.
  • Sibling structure: PASS — the two templates share an identical frontmatter block shape and ## -level section structure; CONTRIBUTING.md's new subsections sit at ### under "Making Changes" alongside the pre-existing "User-Facing Strings".
  • Sibling renames: N/A — no identifier is renamed.
  • Docs: PASS with one carve-outREADME.md and CONTRIBUTING.md are updated in this diff. plugin.yml, COMMANDS.md, USER_GUIDE.md, CONFIG.md and config.yml describe runtime behavior that is unchanged. No CHANGELOG.md entry was added, because nothing a server operator would notice changed; that is the same bar the new "Changelog" subsection states. The carve-out is .github/copilot-instructions.md — see the findings below.
  • Issue resolution: PASSAlign repository with dms-conventions (CLAUDE.md, issue templates, CODEOWNERS, commit/PR conventions) #89 is referenced, not closed, precisely because items 1, 5 and part of 6 are not done; the PR body enumerates each and why.
  • CI: PASSgh pr checks 90 --watch reports build pass on head 69da71e. Its scope does not extend to any changed file, so it confirms only that nothing was broken, not that the change is correct.
  • Privacy: PASS — no code path is added. Both templates instruct reporters to redact IP addresses, and feature_request.md carries a "Privacy Impact" section asking whether a proposal would surface a player's IP, which pushes in the opposite direction from the disclosure this plugin was hardened against.
  • plugin.yml — permissions: N/Aplugin.yml is untouched and no permission is referenced by the diff.
  • plugin.yml — commands: N/A — no subcommand or completion branch is added.
  • @OverRide coverage: N/A — no Java is added.
  • MariaDB compatibility: N/A — no Flyway SQL is added.
  • Encryption determinism: N/AIpEncryption and the lookup paths are untouched.
  • Migration safety: N/A — no migration is added.

Findings folded in from the diff read, none of them blocking:

  • .github/ISSUE_TEMPLATE/feature_request.md:2-5 — the template is named "Feature Request" but tags titles [Improvement] and applies the improvement label. Tag and label match each other, which is what the convention asks for, but this repository's README maps "Planned Features" to the Epic label and "Planned Improvements" to improvement. Epic was deliberately not applied, since Encryption #47 shows it is used for large groupings rather than individual requests. Renaming the template to "Improvement" would remove the last of the mismatch, and is left as a maintainer call rather than churned here.
  • .github/copilot-instructions.md:36 — "Reference the related GitHub issue in every pull request description" is now weaker than the Closes #<number> rule added to CONTRIBUTING.md, and the same file's "Contribution Workflow" says nothing about branch prefixes or commit style. Reconciling it was not attempted: it is agent-loaded configuration whose editing needs separate maintainer authorization, and it is already stale for unrelated reasons under .github/copilot-instructions.md is out of date (stale AafIpsCommand, missing encryption/ package, wrong test-framework status) #62.
  • .github/ISSUE_TEMPLATE/ — no config.yml was added, so the blank-issue option remains available alongside both templates. That is deliberate; audit and epic issues filed on this repository fit neither template.
  • README.md:33 — the bug-report link was pointed at /issues/new/choose, which only offers a chooser once the templates in this same PR land. The two changes are therefore coupled and should not be split across pull requests.
  • One item was fixed during this review rather than left as a comment: the "Changelog" subsection originally said an entry "gets an entry under [Unreleased]", but CHANGELOG.md has no such heading today, making the instruction unfollowable. Commit 69da71e says to add the heading above the most recent release.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

@dmccoystephenson
dmccoystephenson merged commit 9927179 into main Aug 9, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the chore/dms-conventions-alignment branch August 9, 2026 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant