Skip to content

docs: point contributors at dev clones - #7

Merged
Awesome-Ace22 merged 1 commit into
devfrom
chore/doc-links
Oct 20, 2026
Merged

Awesome-Ace22 merged 1 commit into
devfrom
chore/doc-links

Conversation

@Awesome-Ace22

Copy link
Copy Markdown
Contributor

What and why

Adds a "Where to work" note to CONTRIBUTING.md. It tells contributors to clone this repo into the dev/ folder of a Nova-Collected clone (e.g. Nova/dev/frontend) and branch from dev, and never to work in the prod/ or pi/ submodules, which are overwritten on release. Also repoints the testing-procedure reference from the old docs/testing-procedure.md path to its current location in Nova-Collected (docs/development/testing-procedure.md).

How was this tested?

Docs only, so no level applies. I read the rendered CONTRIBUTING.md and checked that the new testing-procedure link points at the file's current path in Nova-Collected.

Hardware impact

  • None - UI, docs or tooling only
  • Changes how a sensor is read, converted or shown
  • Changes how an actuator is commanded, or safety rules, interlocks, timeouts or sequencing → add the hardware-risk label; a lead must approve
  • Changes a message format, MQTT topic or FAS protocol that another repo depends on → title needs !, link the matching PRs:

Checklist

  • Targets dev (or main for a release/hotfix, or with a reason given above)
  • Branch is up to date ("Update branch" button)
  • No station config/calibrations, data files, secrets, .env files or build output committed
  • README/docs updated if behaviour changed (this PR is the docs update)

@Awesome-Ace22
Awesome-Ace22 merged commit a55185c into dev Oct 20, 2026
1 of 2 checks passed
@Awesome-Ace22
Awesome-Ace22 deleted the chore/doc-links branch October 20, 2026 16:29
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