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.
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
If you're new to the project, consider:
- Reading the project's README for an overview.
- Checking the issues labeled as
good first issuefor an easy entry point.
Please follow the bug report template provided in BUG_REPORT_TEMPLATE.md. Include terminal and console logs for a comprehensive report.
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.
Before making any changes, please:
- Open a new issue discussing your proposed change.
- Fork the repository and make your changes in a new branch.
To set up the development environment for this project, you'll need to:
- Install Node.js, Vite, and Vue3.
- Clone the repository.
- Run
npm installto install dependencies. - Follow the instructions for Docker and Vercel deployment in our documentation if necessary.
Ensure that all tests pass and, if applicable, add new tests for your changes. Run npm test to execute tests.
When you're ready to submit your changes:
- Rebase your branch to the latest main branch.
- Ensure your changes adhere to the coding standards and guidelines.
- Submit a pull request with a clear description of your changes.
The project maintainers will review your pull request. They might request changes or provide feedback before merging.
Join our community channels (link your channels here) for support and discussions.
Your contributions are what make this community great. We appreciate your efforts in making this project better!