jose-compu / jose-compu/libvrf-js

docs: Add CONTRIBUTING.md with test matrix and browser notes

Open Beginner friendly
#52 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
TypeScript
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Why
No CONTRIBUTING.md; VRF suite matrix is non-obvious for newcomers.

## Task
Add `CONTRIBUTING.md` covering: Node 18+, `npm test`, which suites are Node-only (RSA) vs browser-capable (EC), PR checklist. Link from README.

## Acceptance
- [ ] Accurate vs README feature matrix
- [ ] Linked from README

## Difficulty
Beginner — documentation only.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the README feature matrix with the Node and browser notes requested in the issue, then create CONTRIBUTING.md with the Node 18+ requirement, npm test command, suite distinctions, and PR checklist. Link the new document from README and run npm test to confirm the documented command works.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.