CONTRIBUTING.md Generator
Generate CONTRIBUTING.md files for open source projects. Set up contribution guidelines, code of conduct, and PR process.
3.2Kuses
7.8/10(363)
Sections
CONTRIBUTING.md
# Contributing to My Project First off, thanks for taking the time to contribute! The following is a set of guidelines for contributing to My Project. ## Table of Contents - [Code of Conduct](#code-of-conduct) - [Reporting Issues](#reporting-issues) - [Development Setup](#development-setup) - [Branch Naming](#branch-naming) - [Commit Messages](#commit-messages) - [Code Style](#code-style) - [Testing](#testing) - [Pull Request Process](#pull-request-process) ## Code of Conduct This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. ## Reporting Issues - Check that the issue has not already been reported - Use the issue templates when available - Include steps to reproduce the problem - Provide environment details (OS, browser, version) - Screenshots are helpful for UI issues ## Development Setup ```bash # Fork and clone the repository git clone https://github.com/user/my-project.git cd my-project # Install dependencies npm install # Start development server npm run dev ``` ## Branch Naming Use the following format for branch names: - `feature/short-description` - New features - `fix/short-description` - Bug fixes - `docs/short-description` - Documentation - `refactor/short-description` - Code refactoring ## Commit Messages We follow [Conventional Commits](https://www.conventionalcommits.org/): ``` <type>(<scope>): <description> [optional body] [optional footer] ``` Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore` ## Code Style - Run `npm run lint` before committing - Follow the existing code style - Use meaningful variable and function names - Add comments for complex logic - Keep functions small and focused ## Testing - Write tests for new features and bug fixes - Run the test suite with `npm test` - Ensure all tests pass before submitting a PR - Aim for meaningful test coverage ## Pull Request Process 1. Update the README.md with details of changes (if applicable) 2. Follow the PR template 3. Request review from at least one maintainer 4. Ensure CI passes 5. Squash commits if requested 6. Delete your branch after merging ## Questions? Feel free to open an issue or reach out to the maintainers. Thank you for contributing!
Why CONTRIBUTING.md?
A CONTRIBUTING.md file helps new contributors understand how to participate in your project effectively.
⚡ Pro OptionsSponsored
Some links on this page are affiliate links. If you click and make a purchase, we may earn a commission at no extra cost to you.
Disclaimer: This tool is provided as-is for informational and educational purposes only.