Skip to content

Commit 4cbff3c

Browse files
authored
docs: align contributor quick-start and cypress command parity (#154)
1 parent 9047186 commit 4cbff3c

File tree

4 files changed

+33
-3
lines changed

4 files changed

+33
-3
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,13 @@ You can get your own free-tier MongoDB-in-the-cloud by [following these instruct
181181

182182
Assumes a unix-like environment, like Ubuntu.
183183

184+
### Contributor quick-start (canonical)
185+
186+
- Use this `README.md` section as the canonical contributor entry point for install, run, and validation commands.
187+
- Use deeper docs as secondary references when needed:
188+
- [`docs/norms/ci-parity.md`](./docs/norms/ci-parity.md) for CI/local parity governance details.
189+
- [`docs/CYPRESS.md`](./docs/CYPRESS.md) for Cypress configuration and troubleshooting specifics.
190+
184191
### Installation
185192

186193
1. Install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
@@ -200,7 +207,17 @@ Assumes a unix-like environment, like Ubuntu.
200207
4. `yarn run ci:local`
201208
- Canonical parity reference for contributors: this command mirrors the required PR-gate validation path in `.github/workflows/netlify-api-test.yml`.
202209
- Intentionally not mirrored by this command: CodeQL/security-analysis workflows and CI runner/bootstrap steps (`actions/checkout`, `actions/setup-node`, global `npm install yarn@^1 -g`).
203-
5. `yarn run test:e2e`
210+
5. `yarn run test:cypress`
211+
212+
### Validation matrix
213+
214+
- **Required PR gate (parity path):**
215+
- `yarn run ci:local`
216+
- **Deeper optional checks:**
217+
- `yarn run test:cypress`
218+
- **Intentionally excluded from parity path:**
219+
- CodeQL/security-analysis workflows.
220+
- CI runner/bootstrap setup steps (for example `actions/checkout`, `actions/setup-node`, and global `npm install yarn@^1 -g`).
204221

205222
### Usage
206223

docs/CYPRESS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Simple Comment uses <https://cypress.io> for frontend browser validation.
44

5+
- Canonical script name: `yarn run test:cypress`
6+
- Primary contributor quick-start lives in `README.md`; this page is a deeper Cypress-specific reference.
7+
58
## Current Layout
69

710
- Cypress config: [cypress.config.ts](../cypress.config.ts)

docs/norms/ci-parity.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Goal: prevent drift between PR-gate validation behavior and local pre-push valid
88

99
Local parity in this repository applies to dependency-resolution + validation behavior.
1010

11+
## Contributor Entry Point
12+
13+
- Canonical quick-start and contributor command entry point: `README.md` (Local development section).
14+
- Secondary references: this document for parity governance details and `docs/CYPRESS.md` for Cypress-specific guidance.
15+
1116
## Required Parity
1217

1318
- Local parity commands MUST run install with the same lockfile/options as the mirrored CI workflow.
@@ -25,3 +30,9 @@ Local parity in this repository applies to dependency-resolution + validation be
2530
- PR-gate workflow: `.github/workflows/netlify-api-test.yml`
2631
- Local parity script: `scripts/ci-local.sh`
2732
- Local parity command: `yarn run ci:local`
33+
34+
## Validation Matrix
35+
36+
- **Required PR gate (parity path):** `yarn run ci:local`
37+
- **Deeper optional checks:** `yarn run test:cypress`
38+
- **Intentionally excluded from parity path:** CI runner/bootstrap setup (`actions/checkout`, `actions/setup-node`, global tool install) and separate security-analysis workflows (for example CodeQL).

docs/plans/ValidationAndDocumentationTrustDraft.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ We likely want README and nearby contributor guidance to stop referencing stale
7777

7878
Known examples worth checking during formal planning:
7979

80-
- `README.md` references `yarn run test:e2e`
81-
- `package.json` currently exposes `test:cypress` rather than `test:e2e`
80+
- Historical drift to resolve: keep Cypress command references normalized to `yarn run test:cypress` across contributor docs and scripts.
8281

8382
### 4. Clear Separation Between Required and Optional Validation
8483

0 commit comments

Comments
 (0)