Contributing Guide

Thank you for considering contributing to this project! This guide will help you get started and ensure a smooth contribution process.

---

Getting Started

1. Fork the repository and clone it to your local machine.
2. Install dependencies:

   npm install

3. Set up environment variables as described in ENV_VARIABLES.md (if present).
4. Start the development server:

   npm run dev

---

Coding Standards

• Use TypeScript for all code.
• Follow the existing folder and file structure (see ARCHITECTURE.md).
• Use descriptive variable and function names.
• Write clear, concise comments where necessary.
• Run the linter before committing:

  npm run lint

• Format code using Prettier (if configured):

  npm run format

---

Making a Pull Request (PR)

1. Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name
   # or
   git checkout -b fix/your-bugfix

2. Make your changes and commit them with clear, descriptive messages.
3. Push your branch to your fork:

   git push origin feature/your-feature-name

4. Open a Pull Request against the main branch of the upstream repository.
5. Describe your changes clearly in the PR description. Link to any related issues.

---

Code Review Process

• All PRs require at least one approval before merging.
• Address all review comments and suggestions.
• Keep PRs focused and as small as possible.
• Squash commits if requested by reviewers.

---

Running Tests & Lint

• Lint:

  npm run lint

• Tests:

  npm run test

• Ensure all tests pass before submitting a PR.

---

Proposing Features or Bug Fixes

• Open an issue describing the feature or bug.
• Provide as much detail as possible (screenshots, steps to reproduce, etc.).
• Wait for feedback before starting major features.

---

Thank you for helping make this project better!