Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,23 @@ Please keep these project principles in mind:

```bash
npm install
npm test
npm run build
```

## Testing expectations

Contributors should run the automated checks before opening a pull request:

```bash
npm test
npm run build
```

Please add or update tests when a contribution changes behavior, parsing logic, scan logic, output shaping, or other user-visible results.

If a change is difficult to cover with an automated test, include a clear reproduction case in the pull request description.

## Pull request guidelines

Please try to keep pull requests focused.
Expand All @@ -58,7 +72,7 @@ A good pull request usually includes:
- a clear description of the problem
- the reasoning behind the change
- before/after examples when output changes
- tests or reproducible cases when relevant
- tests for behavior changes, or a clear explanation when tests are not practical
- documentation updates if user-facing behavior changed

## Commit guidance
Expand Down
Loading