Skip to content

docs: add CONTRIBUTING.md (GH #555) - #602

Open
kotfu wants to merge 5 commits into
mainfrom
docs/contributing
Open

kotfu wants to merge 5 commits into
mainfrom
docs/contributing

Conversation

@kotfu

@kotfu kotfu commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #555.

@chrissnell -- this is the CONTRIBUTING.md draft you asked for in #555. Could you give it a review? There are a handful of policy calls in it that are yours to make, listed below. I'd rather settle them here than guess.

What's in it

  • CONTRIBUTING.md (new). Covers:

    • ways to contribute, and whether a change is right for the project;
    • bug reports and feature requests, and how we use issue labels;
    • dev environment setup and the Makefile targets;
    • running from source, with the web UI and modem dev loops;
    • tests and what CI runs;
    • which docs a change is expected to update (wiki, handbook, release notes);
    • the PR process: branches, workflow, title style, description, checklist, review;
    • using AI coding agents, copyright and licensing, security reports, code of conduct, and getting help.

    It's written so agents can follow it too, per your comment on Draft a CONTRIBUTING.md for review and adoption #555, and it points at docs/wiki/ for architecture.

  • CLAUDE.md: a short section pointing agents at CONTRIBUTING.md.

  • docs/wiki/README.md: an index row for CONTRIBUTING.md.

  • docs/handbook/installation.html: fixes the build-from-source requirements. Go 1.26+ (it said 1.22+; go.mod is go 1.26.2), and adds protoc, which was missing even though the modem's build script needs it.

Decisions needed before adoption

The draft marks each of these with a "Draft note for reviewers" blockquote. Those get removed once they're decided.

  1. Copyright stance on AI-assisted contributions. Do we require disclosure, a DCO Signed-off-by, or a Co-authored-by trailer (required, optional, or discouraged)? Or is "you are the author and responsible for it" enough?
  2. Security-report contact. The draft uses graywolf@nw5w.com, the contact on the handbook's privacy page. Is that the address you want?
  3. Code of conduct. Keep the short inline version, or adopt Contributor Covenant 2.1 as a separate CODE_OF_CONDUCT.md? Either way, please confirm the reporting contact.
  4. Workflow labels. The draft proposes support, needs-info, needs-discussion, needs-second-review and awaiting-author, plus the triage flow that uses them. Two sub-questions:
    • Plain names, matching the existing in-progress, backlog and blocked-pending-other-work? Or a status: prefix, which would also mean renaming those three?
    • Narrow question to design or behavior questions, and move support requests to support and missing-detail reports to needs-info?
  5. Merge style (new since the draft was written). The draft says maintainers "usually squash-merge", so PR titles become commit subjects. Recent merges (Fix IS-received packets logged with DirRX instead of DirIS #540, bugfix: Mic-E - stop rejecting valid Mic-E longitude/speed bytes #568, igate: add regional APRS-IS server choices (GH #593) #594) have used merge commits, though. Which one do we want to document?

Follow-ups, not in this PR

These are separate PRs or repo settings, and none of them block adoption. They're listed in detail in this comment on #555.

  • a Contributing link in the README;
  • PR and issue templates;
  • turning on private vulnerability reporting and auto-delete of head branches;
  • cleaning up old branches;
  • creating the labels once item 4 is decided.

Testing

Docs only. The branch merges cleanly with current main.

🤖 Generated with Claude Code

kotfu and others added 5 commits September 9, 2026 20:55
…555)

Draft contributor guide covering dev-environment setup, Makefile
targets, branch and PR conventions, tests-and-docs requirements, issue
labels, the AI-agent policy, a copyright placeholder, security
reporting, and a code of conduct. Draft-note blockquotes mark the
decisions still open for maintainer review.

Also:
- CLAUDE.md: new section telling agents to read CONTRIBUTING.md and
  keep it current.
- docs/wiki/README.md: index row for CONTRIBUTING.md.
- docs/handbook/installation.html: build-from-source requirements said
  Go 1.22+ and omitted protoc; now Go 1.26+ per go.mod, and protoc is
  listed since the modem build script needs it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…hers fork and sync (GH #555)

Spell out that write access to chrissnell/graywolf is maintainer-only,
so every other contributor forks, keeps the fork's main synced with
upstream, branches on the fork, and opens the PR from there. Adds the
upstream-remote and fast-forward sync commands.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…triage process (GH #555)

Adds support, needs-info, needs-discussion, needs-second-review, and
awaiting-author as proposed labels, with the issue and PR triage flow
maintainers will follow. Narrows the meaning of the existing question
label. A draft note poses the plain-name vs status: prefix decision,
which must be settled before the labels are created.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@kotfu
kotfu requested a review from chrissnell September 24, 2026 03:38
@kotfu kotfu linked an issue Sep 24, 2026 that may be closed by this pull request
@chrissnell

chrissnell commented Sep 24, 2026 via email

Copy link
Copy Markdown
Owner

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.

Draft a CONTRIBUTING.md for review and adoption

2 participants