Repository navigation
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
GitHub's community profile of nodkey is at 62 % (https://github.com/code6x/nodkey/community, seen 2026-10-18). It has a README, a LICENSE (Apache-2.0), a description, and SECURITY.md, and private vulnerability reporting is on. It is missing a code of conduct, a contributing guide, issue templates and a pull request template.
The Open Source Guides say what each file is for. All these pages were seen on 2026-10-18:
- Starting an Open Source Project: a README, a contributing guide and a code of conduct, next to the license;
- Your Code of Conduct: adopt one early, say who enforces it and how to report;
- Building Welcoming Communities: issue and pull request templates, and clear steps for new contributors;
- Best Practices for Maintainers: write your processes down.
GitHub's checklist is in About community profiles for public repositories. Its templates are in Configuring issue templates for your repository.
Most rules exist already in AGENTS.md, docs/releasing.md and SECURITY.md. The new files should point to them, not copy them.
Done when
-
CONTRIBUTING.mdsays how to:- report a bug or ask for a feature: an issue with a "Done when" list;
- report a security problem: privately, as
SECURITY.mdsays; - build and test: Go 1.26 or newer, the commands of
AGENTS.md, and the end-to-end test with Docker; - make a pull request: one issue gives one pull request, with a Conventional Commits title and a squash merge. Tests cover the deny paths too. The docs,
DESIGN.mdandTHREAT-MODEL.mdchange in the same pull request. It also covers the rule for dependencies, no private names or addresses, and plain English; - license a contribution: under Apache-2.0 (section 5 of the license), with no CLA.
It links toAGENTS.md,DESIGN.mdandTHREAT-MODEL.md.
-
CODE_OF_CONDUCT.mdis the Contributor Covenant 2.1, with a way to report. The owner decides the contact. -
.github/ISSUE_TEMPLATE/has two forms and aconfig.yml:- Bug report: the nodkey version, the OS, broker or client, what happened and what you expected, and the log lines. It warns to remove tokens, keys, host names and addresses first.
- Feature request: the problem, the idea, and a "Done when" list.
config.yml: a link to the private security report. Turn blank issues off or leave them on, and say which in the pull request.
-
.github/pull_request_template.mdhas the issue it closes and a short checklist: the title, tests with deny paths, the docs updated, the security review done, and no private data. -
AGENTS.mdlists the new files in its layout. - The community profile page shows every file as done. The owner decides whether to turn on Accept content reports (a repository setting). The pull request says whether
SUPPORT.mdandGOVERNANCE.mdare needed now. For a project with one maintainer, they are probably not.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Activity
groupsky commentedon Nov 9, 2026
Question for @groupsky (work is in #166):
CODE_OF_CONDUCT.md);Please write the exact address or text.
Please answer here and remove the
questionlabel. The other files go on without the answer.groupsky commentedon Nov 18, 2026
Answer from @groupsky (2026-11-18): the code of conduct contact is nodkey@code6.ninja. Content reports: not decided yet; leave the setting as it is for now.
docs: complete GitHub's community standards (#166)
groupsky commentedon Nov 18, 2026
Done in #166 (squash merged as 8ebe354, 2026-11-18).
CONTRIBUTING.md: bug and feature issues with "Done when", private security reports (SECURITY.md), build and test (Go 1.26+, the commands of AGENTS.md, the e2e test with Docker), pull requests (one per issue, Conventional Commits, squash merge, deny-path tests, docs/DESIGN.md/THREAT-MODEL.md in the same PR, dependencies, no private data, plain English), Apache-2.0 section 5 with no CLA. Links to AGENTS.md, DESIGN.md, THREAT-MODEL.md.CODE_OF_CONDUCT.md: Contributor Covenant 2.1, reports to nodkey@code6.ninja (answer above)..github/ISSUE_TEMPLATE/:bug_report.yml(version, OS, broker or client, what happened and what you expected, log lines, warning to remove tokens, keys, host names and addresses),feature_request.yml(problem, idea, "Done when"),config.yml(link to the private security report; blank issues stay on, reason in docs: complete GitHub's community standards #166)..github/pull_request_template.md: the checklist (title, deny-path tests, docs, security review, no private data) is added after the sections of the behavior-change gate (ci: a behavior-change gate: every PR says if it changes behavior for callers #208). The issue line is the gate's "Fixes #N".AGENTS.mdlists the new files.gh api repos/code6x/nodkey/community/profilegiveshealth_percentage: 100on 2026-11-18. (Itsissue_templatefield is stillnull; the API does not see YAML issue forms, but the score counts them.) "Accept content reports" was already on (content_reports_enabled: true); as you said, the setting stays as it is.SUPPORT.mdandGOVERNANCE.mdare not needed now, with one maintainer (reason in docs: complete GitHub's community standards #166).Checks: CI green on #166 (lint, test go.mod and stable, e2e, vuln, PR title);
go test .with Go 1.27 and 1.26; a docs review and the security-reviewer on the whole diff.