Skip to content

docs: add build-before-test instructions to DEVELOPERS.md - #1100

Merged
dselman merged 1 commit into
accordproject:mainfrom
Shubh-Raj:shubhraj/docs/linter-build-before-test
Jan 7, 2026
Merged

dselman merged 1 commit into
accordproject:mainfrom
Shubh-Raj:shubhraj/docs/linter-build-before-test

Conversation

@Shubh-Raj

Copy link
Copy Markdown
Contributor

Closes #1096

Summary

Updates DEVELOPERS.md to clarify that developers must run npm run build before npm run test to ensure all workspace dependencies are compiled.

Context

Per maintainer feedback on #1098, the original issue (#1096) where concerto-linter tests fail on fresh clones is better addressed as a documentation issue rather than a script change. The CI workflows already follow the build → test pattern, but the docs didn't reflect this.

Changes

  • Added npm run build step to the initial setup instructions
  • Added new "Running Tests" section with clear build-before-test guidance
  • Added explanatory note about why this is required (workspace dependencies)
  • Added example for running tests on a specific package

Author Checklist

  • DCO sign-off provided
  • Follows Accord Project commit message format
  • Documentation change only (no code changes)

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 accordproject#1096

Signed-off-by: Shubh-Raj <shubhraj625@gmail.com>
@dselman
dselman merged commit e97b49f into accordproject:main Jan 7, 2026
13 checks passed
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.

fix: concerto-linter tests fail on fresh clones

2 participants