Skip to content

Commit 9c0bf6e

Browse files
committed
docs: update CONTRIBUTING guide with CI information
1 parent 439873d commit 9c0bf6e

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,24 @@ npm test
4242

4343
- Use 2 spaces for indentation
4444
- Follow existing code patterns
45-
- Add JSDoc comments for functions
4645
- Keep functions focused and small
46+
- Write clear, self-documenting code
4747

4848
## Testing
4949

5050
- Write tests for new features
5151
- Ensure all tests pass before submitting PR
5252
- Aim for high test coverage
53+
- CI runs tests automatically on Node 18.x, 20.x, and 22.x
5354

5455
```bash
5556
npm test # Run all tests
5657
npm test -- --watch # Watch mode
58+
npm test -- --coverage # Run with coverage report
5759
```
5860

61+
All pull requests are automatically tested via GitHub Actions CI before merge.
62+
5963
## Most Impactful Contributions
6064

6165
1. **Expanding `data/licenses.json`** — Add more license mappings with accurate permission attributes

0 commit comments

Comments
 (0)