Welcome to the Patria AR project! We're thrilled that you're interested in contributing to our open-source search engine. This document outlines how you can get involved and make meaningful contributions to our project.
There are several ways you can contribute to the Patria AR project:
If you have coding skills and want to contribute to the development of Patria AR, you can:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-nameorgit checkout -b bugfix/your-bugfix-name. - Make your changes, write code, and test thoroughly.
- Commit your changes:
git commit -m "Description of your changes". - Push your changes to your fork:
git push origin feature/your-feature-nameorgit push origin bugfix/your-bugfix-name. - Open a pull request (PR) to the
mainbranch of this repository.
Please ensure that your code follows our coding standards and practices, and include clear and concise commit messages and PR descriptions.
Good documentation is crucial for our project's success. You can help by:
- Improving existing documentation.
- Adding documentation for features or functions that are lacking.
- Correcting typos, grammar, and formatting issues.
You can make documentation contributions by following the same fork and pull request process mentioned above, but targeting the documentation branch or mentioning that it's a documentation update in your PR description.
If you come across a bug or have a feature request, please open an issue on our Issue Tracker. Provide as much detail as possible to help us understand and address the problem or request.
Before contributing, please review our Code of Conduct to ensure a respectful and inclusive environment for all community members.
By contributing to the Patria AR project, you agree that your contributions will be licensed under the project's LICENSE. Please read the license carefully.
Thank you for contributing to the Patria AR project! We appreciate your support and look forward to your contributions.