Before starting to contribute to this project, please familiarize yourself with the code architecture and design decisions by reading ARCHITECTURE.md.
I already have created some starter issues you can pick up.
Below is a set of general guidelines for different types of changes.
Please use Conventional Commits for our pull request titles (and commit messages on the master branch) and also include the author name at the end inside parenthesis. Please follow the guidelines below when naming pull requests.
For types, we use the following:
feat: A new featureimpr: An improvement to an existing featurefix: A bug fixdocs: Documentation only changesstyle: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc)refactor: A code change that neither fixes a bug nor adds a feature, but makes the code easier to read, understand, or improveperf: A code change that improves performancetest: Adding missing tests or correcting existing testsbuild: Changes that affect the build system or external dependencies (example scopes: vite, tsup-node, npm)ci: Changes to our CI configuration files and scripts (example scopes: GitHub Workflows)revert: Reverts a previous commitchore: Other changes that don't apply to any of the above
The issues should have steps to reproduce the bug, if it's a bug.
The PRs should have a clear description of the changes made and should follow the Conventional Commits naming guidelines.
UI changes should be minimal and should not affect the user experience. It should be responsive and should work on all devices. Add a screenshot should be added to demonstrate the before/after changes.
If you have any questions, feel free to open an issue or a discussion thread.