Welcome to the Quantum project! We appreciate your interest in contributing to the project. This document tells you how you can help us improve Quantum.
Please read and follow our Code of Conduct to ensure a welcoming and inclusive environment for everyone.
If you find a bug, please create an issue on our GitHub Issues page. Provide as much detail as possible, including steps to reproduce the bug, the expected behavior, the browser you are using, and any relevant screenshots or error messages.
Since Quantum is still in the early stages of development, we welcome any suggestions for improvements. You can create an issue on our GitHub Issues page to suggest new features, enhancements, or changes to existing functionality. Please keep in mind that we may not be able to implement every suggestion.
- Fork and clone the repository.
- Create a new branch for your feature or bugfix:
git checkout -b my-feature-branch - Make your changes and commit them with clear and concise commit messages.
- Push your changes to your fork:
git push origin my-feature-branch - Create a pull request on the main repository. Provide a detailed description of your changes and reference any fixed or related issues.
Check out the Development Documentation to get started with setting up your development environment.
Please follow the existing code style and conventions used in the project. We use ESLint and Prettier to enforce code quality and formatting. Husky should automatically run these tools when you commit changes, but you can also run them manually with pnpm lint where it is available.