Overview
README.md is 9.7 KB of setup and feature documentation. A contributor following it will run npm test (190 suites fail), npm run lint (configuration error) and npm run build (blocked by validate-env requiring an undocumented variable) with no warning that any of these is expected to fail. CI_FIXES_COMPLETE.md at the repository root actively asserts the opposite. Getting a new contributor productive is currently a matter of luck.
Specifications
Features:
- A "Known issues" section listing the broken gates and linking to their tracking issues
- A verified quickstart that works on a clean checkout
- The stale
CI_FIXES_COMPLETE.md removed
Tasks:
- Walk through the README on a clean clone and record every step that fails
- Add a "Known issues" section with links to the relevant issues
- Correct the quickstart, including the required environment variables
- Remove or rewrite
CI_FIXES_COMPLETE.md
Impacted Files:
README.md
CI_FIXES_COMPLETE.md
CONTRIBUTING.md
.env.example
Acceptance Criteria
- A clean checkout can be set up by following the README exactly
- Known broken gates are disclosed and linked
- No document claims CI is healthy while it is not
Overview
README.mdis 9.7 KB of setup and feature documentation. A contributor following it will runnpm test(190 suites fail),npm run lint(configuration error) andnpm run build(blocked byvalidate-envrequiring an undocumented variable) with no warning that any of these is expected to fail.CI_FIXES_COMPLETE.mdat the repository root actively asserts the opposite. Getting a new contributor productive is currently a matter of luck.Specifications
Features:
CI_FIXES_COMPLETE.mdremovedTasks:
CI_FIXES_COMPLETE.mdImpacted Files:
README.mdCI_FIXES_COMPLETE.mdCONTRIBUTING.md.env.exampleAcceptance Criteria