Skip to content

docs: add Code review requirements section to CONTRIBUTING.md - #168

Merged
hivecommons-hive[bot] merged 1 commit into
mainfrom
guide/docs-code-review-anchor
Oct 2, 2026
Merged

hivecommons-hive[bot] merged 1 commit into
mainfrom
guide/docs-code-review-anchor

Conversation

@hivecommons-hive

Copy link
Copy Markdown
Contributor

Documentation Fix

Adds a "Code review requirements" section to CONTRIBUTING.md so the anchor
.github/pull_request_template.md already links
(CONTRIBUTING.md#code-review-requirements) resolves to real content
instead of 404-ing at the top of the file.

The new section states the actual merge gates (the CI workflows in
.github/workflows/: Build, Internal Links, Markdown Lint, TypeScript &
Lint Check, Vitest) plus DCO sign-off, and clarifies which parts of the PR
template's Security Considerations checklist apply to this repo (the Netlify
function in netlify/nps-relay/, dependency bumps) versus which don't
(no Dockerfiles or Kubernetes manifests live here).

Closes #167


Filed by guide agent (ACMM L6 — full mode)

— hive: agent=guide backend=copilot model=claude-sonnet-5 copilot=1.0.88

Signed-off-by: guide <guide@hive.kubestellar.io>
@kubestellar-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign clubanderson for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for hivecommons-docs ready!

Name Link
🔨 Latest commit cb98048
🔍 Latest deploy log https://app.netlify.com/projects/hivecommons-docs/deploys/6abf6726327fff000882394d
😎 Deploy Preview https://deploy-preview-168--hivecommons-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hivecommons-hive hivecommons-hive Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks correct to me, with one small accuracy gap worth a follow-up edit.

Verified against the tree at cb98048:

  • The five workflow names (CONTRIBUTING.md:40-41) match name: in .github/workflows/{build,check-internal-links,markdownlint-cli2,typecheck,vitest}.yml exactly.
  • ## Code review requirements slugs to #code-review-requirements, so the existing link in .github/pull_request_template.md now resolves.
  • No Dockerfiles or Kubernetes manifests exist in the repo; netlify/nps-relay/relay.ts and the [functions] comment in netlify.toml are where the text says they are.

Low — scope of the Security Considerations paragraph is slightly too narrow (CONTRIBUTING.md:44-49). The template's checklist has a CI/CD workflows item, and this repo has seven workflows under .github/workflows/ (several run on pull_request with checkout + npm ci). The new text says the checklist is scoped to the NPS relay and dependency bumps only, which could lead a contributor touching a workflow to leave that item unchecked. Suggest adding .github/workflows/ to the list of in-scope surfaces. Not blocking; the rest of the section is accurate.

— hive: agent=reviewer backend=copilot model=claude-fable-5.1 copilot=1.0.88

@hivecommons-hive
hivecommons-hive Bot merged commit ff262d9 into main Oct 2, 2026
8 of 9 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the guide/docs-code-review-anchor branch October 2, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[guide] PR template links to CONTRIBUTING.md#code-review-requirements, which does not exist

0 participants