# Contributing Guide

We welcome contributions from everyone! Here's how you can help improve this project.

## 🚀 Getting Started

### Prerequisites
- Node.js 20+
- npm 9+ or yarn 1.22+
- Git

### Setup
1. Fork the repository
2. Clone your fork:
   ```bash
   git clone https://github.com/pavelkalininn/create-vite-querybook.git
Install dependencies:

bash
npm install
Create a new branch:

bash
git checkout -b feature/your-feature-name

### 💡 How to Contribute

Report Bugs
Check if the bug already exists in [Issues]

Create a new issue with:

Clear title and description

Steps to reproduce

Expected vs actual behavior

Screenshots if applicable

Suggest Enhancements
Check existing feature requests

Create a new issue with:

Detailed description

Use cases and benefits

Proposed implementation (optional)

Submit Code Changes
Make your changes following our:

Code Style Guide

Commit Convention

Write tests for new features

Update documentation if needed

Submit a Pull Request

🛠 Development

JavaScript/TypeScript

Use TypeScript for all new code

Prefer functional components with hooks

Keep files small (<300 lines)

CSS/Styling
Use CSS Modules for component styles

Follow BEM naming convention

Prefer CSS variables over preprocessor variables

✨ Commit Messages
We follow Conventional Commits:

type(scope): description
Allowed types:

feat: New features

fix: Bug fixes

docs: Documentation changes

style: Code style/formatting

refactor: Code changes that neither fix nor add a feature

test: Test additions

chore: Maintenance tasks

Example:

feat(cli): add --mobx flag support


### 🔍 Review Process

PR will be reviewed by maintainers

We may request changes

Once approved, it will be squashed and merged

Your contribution will appear in release notes

Thank you for contributing! 🎉


Key features of this CONTRIBUTING.md:
1. Clear setup instructions
2. Multiple contribution paths (bugs, features, code)
3. Project structure overview
4. Code style guidelines
5. Commit message convention
6. Review process transparency

You can customize the specific style guidelines, project structure, and community links to match your exact project setup.