Skip to content

docs: complete GitHub's community standards (contributing, code of conduct, templates) #97

Closed

Description

@groupsky

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:

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.md says how to:
    • report a bug or ask for a feature: an issue with a "Done when" list;
    • report a security problem: privately, as SECURITY.md says;
    • 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.md and THREAT-MODEL.md change 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 to AGENTS.md, DESIGN.md and THREAT-MODEL.md.
  • CODE_OF_CONDUCT.md is the Contributor Covenant 2.1, with a way to report. The owner decides the contact.
  • .github/ISSUE_TEMPLATE/ has two forms and a config.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.md has 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.md lists 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.md and GOVERNANCE.md are needed now. For a project with one maintainer, they are probably not.

Activity

  1. groupsky commented on Nov 9, 2026

    @groupsky
    ContributorAuthor

    Question for @groupsky (work is in #166):

    1. Code of conduct contact. Where should people report a code of conduct problem? Options:
      • an email address that you choose (it will be public in CODE_OF_CONDUCT.md);
      • no email: "contact the maintainer @groupsky on GitHub" (there is no private message on GitHub, so this is weaker).
        Please write the exact address or text.
    2. Accept content reports (repository setting): turn it on, or leave it off?

    Please answer here and remove the question label. The other files go on without the answer.

  2. groupsky commented on Nov 18, 2026

    @groupsky
    ContributorAuthor

    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.

  3. groupsky commented on Nov 18, 2026

    @groupsky
    ContributorAuthor

    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.md lists the new files.
    • Community profile: gh api repos/code6x/nodkey/community/profile gives health_percentage: 100 on 2026-11-18. (Its issue_template field is still null; 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.md and GOVERNANCE.md are 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions