Description
The README.md links to a CONTRIBUTING.md file that does not exist in the repository. A contributing guide should be created to help new contributors understand how to set up the project, run tests, follow coding conventions, and submit pull requests.
Current State
The README says:
Contributions are welcome! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
But no CONTRIBUTING.md file exists in the repository.
Required Content
Create CONTRIBUTING.md covering:
- Getting Started — Prerequisites, cloning, installing dependencies (
npm install)
- Development Workflow — How to compile (
npm run compile), watch (npm run watch), and test (npm test)
- Code Style — Linting with ESLint, TypeScript strict mode
- Pull Request Process — Branch naming, commit message conventions, review expectations
- Project Structure — Brief overview of
src/ modules and what each does
- Testing — How to write and run tests
Acceptance Criteria
Complexity
Trivial — documentation only, no code changes.
Points
100
Description
The README.md links to a
CONTRIBUTING.mdfile that does not exist in the repository. A contributing guide should be created to help new contributors understand how to set up the project, run tests, follow coding conventions, and submit pull requests.Current State
The README says:
But no
CONTRIBUTING.mdfile exists in the repository.Required Content
Create
CONTRIBUTING.mdcovering:npm install)npm run compile), watch (npm run watch), and test (npm test)src/modules and what each doesAcceptance Criteria
CONTRIBUTING.mdexists at the repository rootComplexity
Trivial — documentation only, no code changes.
Points
100