CONTRIBUTING.md

CONTRIBUTING.md

Welcome Contributors! 👋

We're delighted that you're interested in contributing to our project! This document provides guidelines to ensure a smooth contribution process for everyone involved.

Table of Contents

• CONTRIBUTING.md
  • Welcome Contributors! 👋
    • Table of Contents
    • Code of Conduct
    • Getting Started
    • Reporting Bugs
    • Feature Requests
    • Submitting Changes
    • Setting Up Your Environment
    • Testing
    • Pull Request Guidelines
    • Code Review Process
    • Community and Support
  • Thank You! 👏

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

If you're new to the project, consider:

• Reading the project's README for an overview.
• Checking the issues labeled as good first issue for an easy entry point.

Reporting Bugs

Please follow the bug report template provided in BUG_REPORT_TEMPLATE.md. Include terminal and console logs for a comprehensive report.

Feature Requests

We love to hear your ideas! Open an issue with the tag feature request and provide a clear and detailed explanation of the feature and its benefits.

Submitting Changes

Before making any changes, please:

1. Open a new issue discussing your proposed change.
2. Fork the repository and create your branch from dev — all contributions are based on dev, not main.

Setting Up Your Environment

To set up the development environment for this project, you'll need to:

1. Install Node.js, Vite, and Vue3.
2. Clone the repository.
3. Run pnpm install to install dependencies.
4. Follow the instructions for Docker and Vercel deployment in our documentation if necessary.

Testing

Ensure that all tests pass and, if applicable, add new tests for your changes. Run pnpm test to execute tests.

Pull Request Guidelines

When you're ready to submit your changes:

1. Open your pull request against the dev branch — not main. main only receives release merges from dev, so any PR targeting main will be asked to retarget.
2. Rebase your branch onto the latest dev before submitting.
3. Keep one concern per PR — don't bundle unrelated changes (e.g. a feature plus a dev-environment tweak) into the same pull request.
4. Ensure your changes adhere to the coding standards and guidelines, with a clear description of what you changed.

Code Review Process

The project maintainers will review your pull request. They might request changes or provide feedback before merging.

Community and Support

Join our community channels (link your channels here) for support and discussions.

Thank You! 👏

Your contributions are what make this community great. We appreciate your efforts in making this project better!