Repository navigation
docs: complete the GitHub community standards checklist - #28
Merged
Merged
Conversation
The community profile sat at 62%: description, README, CONTRIBUTING, LICENSE and SECURITY.md were present, but the code of conduct, issue templates and pull request template were missing. CODE_OF_CONDUCT.md is Contributor Covenant 2.1 verbatim, with the scope and enforcement sections pointed at this repo. Reports route through GitHub's private reporting form — the only private channel the project has — and a note keeps the response-time expectations honest, matching the caveat SECURITY.md already gives. Issue forms are project-shaped rather than generic. The bug report leads with "did this lose or change your writing?", because CONTRIBUTING says data-safety bugs outrank everything, and asks whether the folder is an Obsidian vault, synced, or open in another editor — context that explains most behavior that otherwise looks random. The feature request states the already-decided noes (§12) up front so nobody writes a proposal for something that was never on the table, and routes open-ended ideas to Discussions. The PR template deliberately doesn't ask for test output: CI now runs the gates on Ubuntu and Windows. It asks for what CI can't produce — live window verification, what was left unverified, data-safety impact, and whether CLAUDE.md's command contract needs updating. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repo's community profile sits at 62%. Description, README, CONTRIBUTING, LICENSE (Apache-2.0) and SECURITY.md are already in place; this adds the three missing items.
CODE_OF_CONDUCT.md.github/ISSUE_TEMPLATE/(bug, feature, config).github/PULL_REQUEST_TEMPLATE.mdCode of conduct
Contributor Covenant 2.1, verbatim, with scope and enforcement pointed at this repo.
One thing to check before merging: the enforcement contact routes to GitHub's private reporting form, because that's the only private channel this project currently has. It works, and it avoids publishing a personal email address in a public repo — but if you'd rather have a dedicated conduct address, that line is the one to change. Reporters are told to mark conduct reports clearly so they aren't triaged as vulnerabilities.
A short note also keeps expectations honest about a spare-time project having no moderation staff — the same caveat SECURITY.md already makes for vulnerability response.
Issue forms
Written for this project rather than filled in from a generic template:
.mdand.htmlgo through separate serializers.config.ymlkeeps blank issues enabled and adds contact links for security reporting, Discussions, and the contributing guide.Pull request template
Deliberately doesn't ask for test output — CI now runs typecheck, tests, build and the Rust crates on Ubuntu and Windows. It asks for what CI can't produce:
Kept short on purpose: a long PR template gets deleted wholesale.
Verification
Both issue forms validated against GitHub's schema — YAML parses, block types are legal, every non-markdown block has an
id, andvalidationssits as a sibling ofattributesrather than nested inside it. That last check caught a real defect in the feature form before it shipped.🤖 Generated with Claude Code