Skip to content

docs(contributing): explain the board-review check for fork PRs - #453

Open
msgwing wants to merge 2 commits into
mainfrom
docs/contributing-board-review-note
Open

msgwing wants to merge 2 commits into
mainfrom
docs/contributing-board-review-note

Conversation

@msgwing

@msgwing msgwing commented Sep 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • tools/check-board-review.py (added 2026-09-01, PR ci: a change that cannot be undone by a later commit carries a verdict #410) fails
    unconditionally on any pull request opened from a fork — which is how
    every external contribution to this repo arrives, including the
    "good first issue" data/devices.json entries this funnel exists for.
  • CONTRIBUTING.md said nothing about it. A newcomer following the documented
    PR process would see a red board-review check and an error message
    pointing at .claude/agents/change-board.md, an internal agent workflow
    doc with no meaning to a human contributor.
  • This already happened: PR Enforce device panel code documentation invariant in check-facts (#408) #416 (Mohitingale13, from their own fork) needed
    a maintainer to add the BOARD:/EVIDENCE: lines by hand after the fact,
    quoted in the PR body as "Added by the maintainers on merge."

Change

Seven lines added to the "Pull request process" section of CONTRIBUTING.md,
telling a contributor plainly that the red check is expected, is not
something they need to fix, and has no bearing on whether the change is
wanted.

Verification

  • git diff CONTRIBUTING.md — single, contiguous insertion, nothing else
    touched.
  • No workflow lints CONTRIBUTING.md; checked .github/workflows/lint.yml
    for a job referencing the file — none exists.

…d checks restored

Three weeks since v1.8.0: setup-postfix-relay.sh and a companion Ansible
role automate the sender-rewrite step that was causing real "not owned by
user" rejections; zerosmtp-check --explain no longer matches an enhanced
code against a contradicting reply code; main's required status checks are
restored to all 29 real gates instead of the 11 example-language linters
that were silently the only ones enforced for ten days.
New contributors opening a PR from a fork now hit a red board-review
check unconditionally, added 2026-09-01. CONTRIBUTING.md never
mentioned it, so the check message points to an internal agent doc
a human contributor cannot act on. #416 already needed a maintainer
to add the BOARD:/EVIDENCE lines by hand for exactly this reason.
@msgwing
msgwing enabled auto-merge (squash) September 20, 2026 13:09

This branch has not been deployed

No deployments
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