docs: add agent guidance and threat model - #2828
Open
smoelius wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2828 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 114 114
Lines 2600 2600
Branches 659 659
=========================================
Hits 2600 2600 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tux-tn
requested changes
Jul 28, 2026
tux-tn
left a comment
Member
There was a problem hiding this comment.
Overall, this is a useful addition, especially as we receive more AI-assisted contributions. I also added a suggestion regarding the Node.js guidance
|
|
||
| - Use npm for the official build and test path. | ||
| - Install development dependencies with `npm install --legacy-peer-deps`, as documented in `CONTRIBUTING.md` and used by CI. | ||
| - Prefer Node.js 24 for local work. CI also tests Node.js 8, 10, 12, 14, 16, 18, 20, and 22, so avoid syntax or runtime APIs unsupported by the intended compatibility range. |
Member
There was a problem hiding this comment.
Could we make this guidance more generic and avoid hard-coding the CI matrix and future maintenance?
For example:
Suggested change
| - Prefer Node.js 24 for local work. CI also tests Node.js 8, 10, 12, 14, 16, 18, 20, and 22, so avoid syntax or runtime APIs unsupported by the intended compatibility range. | |
| - Prefer the latest Node.js LTS release for local development. When adding syntax or runtime APIs, follow the compatibility range declared in `package.json` and verify compatibility with the Node.js versions supported by CI. |
This keeps the guidance current as the supported Node.js versions and CI matrix change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add
AGENTS.mdwith repository-specific guidance for coding agents, including theproject layout, build and test workflows, change discipline, and standards for
security analysis and reproduction.
Add
THREAT_MODEL.mdto document validator.js's security boundaries, expectedproperties, threat scenarios, possible controls, and non-binding guidance for
reviewing and classifying findings. The threat model also clarifies the
responsibilities retained by applications integrating validator.js.
This PR changes documentation only; it does not alter the public API, runtime
behavior, generated distributions, or package contents.
References used to describe the project and its security and release boundaries:
README.mdSECURITY.mdpackage.jsonChecklist