Skip to main content

Contributing.md Builder

v1.0.4

Build CONTRIBUTING.md templates with setup and pull-request guidelines.

Builds CONTRIBUTING.md templates with repo setup instructions, branch strategy, PR checklist, commit message guidelines, and code style references for open source projects.

How to use
  • Fill in the setup steps, test commands, and code style guide links for your project.
  • Toggle sections on/off depending on your project's needs.
  • Copy the Markdown and save it as CONTRIBUTING.md in your repository root.
CONTRIBUTING.md
# Contributing to my-awesome-lib

Thank you for helping improve my-awesome-lib.

## Development Setup
1. Fork the repository
2. Clone your fork
3. Install dependencies with `npm install`
4. Create a feature branch

## Code Style
Follow ESLint config. Run `npm run lint` before submitting.

## Pull Requests
- Keep PRs focused and small
- Add tests for behavior changes
- Describe context and motivation

## Validation
Run:

```bash
npm test
```