Contributing Guide Generator
Draft CONTRIBUTING.md with your project’s commands, branching model, test coverage and review checklist.
contributing-guide-generatorLOCAL WORKSPACE
Enabling local controls…
Settings
Results
CONTRIBUTING.md
# Contributing to sample\-project
## Development environment
Clone the repository and install Git and the JavaScript toolchain.
### Install dependencies
```sh
npm install
```
### Start development
```sh
npm run dev
```
### Run tests
```sh
npm test
```
### Run lint
```sh
npm run lint
```
- Minimum test coverage · 80%
## Branches and commits
Branch from main for a feature or fix, and open a PR against main.
Use [Conventional Commits](https://www.conventionalcommits.org/).
## Pull requests
Explain why the change is needed, list the verification steps you ran, and update affected documentation before requesting review.
### PR checklist
- [ ] Describe the change and motivation
- [ ] Tests pass
- [ ] Update affected documentation
## Reporting issues
Include your environment, minimal reproduction steps, and expected and actual results.
## Code of conduct
Follow the project's [code of conduct](CODE_OF_CONDUCT.md).
How to use this tool
Draft CONTRIBUTING.md with your project’s commands, branching model, test coverage and review checklist.
When not to use it
Commands are exported as fenced text. Review them in your own project and add any required prerequisites.