From ca1d03fca66e8927ed5276355a8fc1ca56ebedc4 Mon Sep 17 00:00:00 2001 From: Shubh-Raj Date: Wed, 7 Jan 2026 00:10:35 +0530 Subject: [PATCH] docs: add build-before-test instructions to DEVELOPERS.md Clarify that developers must run npm run build before npm run test to ensure all workspace dependencies are compiled. This addresses confusion when tests fail on fresh clones due to missing compiled dependencies (e.g., concerto-linter depends on default-ruleset). Closes #1096 Signed-off-by: Shubh-Raj --- DEVELOPERS.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index c00336b001..9b8e7cce2e 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -23,6 +23,30 @@ git remote add upstream "https://github.com/accordproject/concerto.git" # Install node.js dependencies: npm i + +# Build all packages: +npm run build +``` + +#### Running Tests + +Before running tests, you must first build the project to compile all workspace dependencies: + +```shell +# Build all packages (required before testing): +npm run build + +# Run all tests: +npm run test +``` + +> **Note:** The build step is required because some packages (like `concerto-linter`) depend on other workspace packages that need to be compiled first. The CI workflows follow this same pattern: build first, then test. + +If you're working on a specific package, you can run tests for just that package: + +```shell +# Run tests for a specific package: +npm run test -w @accordproject/concerto-core ``` [apdev]: https://github.com/accordproject/techdocs/blob/master/DEVELOPERS.md