Thank you for your interest in Vectara-ingest and considering contributing to our project! Whether it's a bug, a new crawler, updates to the documentation or anything else - we truly appreciate your time and effort.
This document provides guidelines and best practices to help you contribute effectively.
- Fork the repository and clone your fork.
- Create a new branch for your changes (e.g.
bug-fix-1234) - Make your changes in the new branch and test.
- Commit and push your changes to your fork. Add useful comments to describe your changes.
- Create a pull request following the guidelines in the Submitting Pull Requests section.
If you find a bug in the project, please create an issue on GitHub with the following information:
- A clear, descriptive title for the issue.
- A description of the problem, including steps to reproduce the issue.
- Any relevant logs, screenshots, or other supporting information.
If you have an idea for a new feature or improvement, please create an issue on GitHub with the following information:
- A clear, descriptive title for the issue.
- A detailed description of the proposed enhancement, including any benefits and potential drawbacks.
- Any relevant examples, mockups, or supporting information.
When submitting a pull request, please ensure that your changes meet the following criteria:
- Your pull request should be atomic and focus on a single change.
- You should have thoroughly tested your changes with multiple different scenarios.
- You should have considered potential risks and mitigations for your changes.
- You should have documented your changes clearly and comprehensively.
- Please do not include any unrelated or "extra" small tweaks or changes.