Thank you for investing your time in contributing to our project!
Please read our Code of Conduct to keep our community approachable and respectable.
This guide will provide an overview of the contribution workflow, including opening an issue, creating a pull request (PR), and the review and merge process.
If you come across an issue or have a feature request, please search if a related issue has already been reported. If no relevant issue exists, you can open a new issue using the appropriate issue form.
To find an issue that interests you, you can browse through our existing issues and use the available labels
to narrow down your search (See Labels for more information). As a general rule, if you find an issue you want to work on, you are welcome to open a PR with a fix.
Once you have finished making your changes, create a pull request (PR) to submit them.
- Fill out the "Ready for review" template to help reviewers understand your changes and the purpose of your PR.
- If you are addressing an existing issue, don't forget to link your PR to the issue.
- Enable the checkbox to allow maintainer edits so that the branch can be updated for merging.
- Once you submit your PR, a team member will review your proposal. They may ask questions or request additional information.
- You may be asked to make changes before the PR can be merged, either through suggested changes or pull request comments. You can apply suggested changes directly through the UI. For other changes, you can make them in your fork and commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, refer to this git tutorial to help you resolve merge conflicts and other issues.
Congratulations! 🎉🎉 The search team thanks you for your contribution! ✨
Once your PR is merged, your changes will be included in the next release of the application.
- Tantivy - Search engine library
- Tauri - Rust version of Electron
- Scala.js - Scala version of Typescript
- Slinky React - UI framework
- Diode - state management
- sdk - Shared models
- search-engine - Core indexing, searching etc Rust crates.
- web - Shared React