# Contributing to [Project Name]
Thank you for your interest in contributing! π
## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Development Setup](#development-setup)
- [Pull Request Process](#pull-request-process)
- [Style Guidelines](#style-guidelines)
## Code of Conduct
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
## How Can I Contribute?
### π Reporting Bugs
- Check if the bug already exists in [Issues](../../issues)
- Use the bug report template
- Include steps to reproduce
- Include expected vs actual behavior
### π‘ Suggesting Features
- Open an issue with the feature request template
- Explain the use case and benefits
- Be open to discussion
### π Improving Documentation
- Fix typos, improve clarity
- Add examples
- Translate documentation
### π» Contributing Code
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request
## Development Setup
```bash
# Clone your fork
git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
cd REPO-NAME
# Install dependencies
npm install
# Run in development mode
npm run dev
# Run tests
npm test
# Build for production
npm run build
```
## Pull Request Process
1. **Branch naming**: `feature/description`, `fix/description`, `docs/description`
2. **Commits**: Use [Conventional Commits](https://conventionalcommits.org/)
- `feat: add new feature`
- `fix: resolve bug`
- `docs: update readme`
- `chore: update dependencies`
3. **Tests**: Ensure all tests pass
4. **Documentation**: Update relevant docs
5. **Review**: Respond to feedback
## Style Guidelines
### Code Style
- Follow the existing code style
- Run linter before committing: `npm run lint`
- Format code: `npm run format`
### Commit Messages
```
type(scope): brief description
Longer explanation if needed.
Fixes #123
```
### Documentation
- Use clear, concise language
- Include code examples
- Update README if adding features
## Questions?
Feel free to open an issue or reach out to maintainers.
Thank you for contributing! πͺ