Contributing to Project Name

Thank you for investing your time in improving this open-source project!

📜 Code of Conduct

This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code. Please report unacceptable behavior to security@example.com.

🚀 Getting Started

Prerequisites

• Node.js >= 20.0.0
• Git

Local Setup

# 1. Fork the repo and clone your fork
git clone https://github.com/<your-username>/project-name.git
cd project-name

# 2. Install dependencies
npm install

# 3. Create development environment file
cp .env.example .env

# 4. Run local database migrations
npm run db:migrate

# 5. Start development server
npm run dev

🌿 Branching & Commit Conventions

Branch Names

• feat/short-description (new features)
• fix/issue-description (bug fixes)
• docs/page-name (documentation improvements)
• perf/component-name (performance improvements)

Conventional Commits

Use semantic commit messages:

• feat(auth): add passkey authentication support
• fix(editor): prevent cursor jump on autosave
• perf(db): add composite index on user_id and created_at
• docs(readme): update deployment instructions

🧪 Testing Guidelines

Before opening a pull request, ensure all tests pass:

npm run test
npm run test:coverage

Pull requests without unit or integration tests for new features will not be merged.