diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0eeace..bac3e4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,12 @@ Read that first.** In short: - CI green + 1 approval (a lead's if it can move hardware), then **Squash and merge**. - Leads bring tested releases into `main`; you never merge into `main` yourself. +**Where to work:** clone this repo into the `dev/` folder of a Nova-Collected +clone, e.g. `Nova/dev/frontend` (see "Getting started as a developer" in the +Nova-Collected README), or anywhere else you like. Branch from `dev` there. +Never work in the `prod/` or `pi/` submodules of Nova-Collected: they show the +released version and are overwritten when it changes. + This file only covers what is specific to this repo. ## Before you open a PR @@ -26,7 +32,7 @@ CI runs the same checks on every PR. Run the backend with its simulators (see novaOps-back `CONTRIBUTING.md`), then `npm run dev`, and go through the testing procedure -(`docs/testing-procedure.md` in Nova-Collected). The UI talks to the backend +([testing procedure](https://github.com/UTATRocketry/Nova-Collected/blob/main/docs/development/testing-procedure.md)). The UI talks to the backend URL in `.env.local`; copy `.env.example` to start. ## Scopes for PR titles