| sidebar_position | slug |
|---|---|
0 |
/contribution_guidelines |
Thanks for wanting to contribute to RAGFlow. This document offers guidlines and major considerations for submitting your contributions.
- To report a bug, file a GitHub issue with us.
- For further questions, you can explore existing discussions or initiate a new one in Discussions.
The list below mentions some contributions you can make, but it is not a complete list.
- Proposing or implementing new features
- Fixing a bug
- Adding test cases or demos
- Posting a blog or tutorial
- Updates to existing documents, codes, or annotations.
- Suggesting more user-friendly error codes
- Fork our GitHub repository.
- Clone your fork to your local machine:
git clone git@github.com:<yourname>/ragflow.git - Create a local branch:
git checkout -b my-branch - Provide sufficient information in your commit message
git commit -m 'Provide sufficient info in your commit message' - Commit changes to your local branch, and push to GitHub: (include necessary commit message)
git push origin my-branch. - Submit a pull request for review.
- Consider splitting a large PR into multiple smaller, standalone PRs to keep a traceable development history.
- Ensure that your PR addresses just one issue, or keep any unrelated changes small.
- Add test cases when contributing new features. They demonstrate that your code functions correctly and protect against potential issues from future changes.
- Ensure that your PR title is concise and clear, providing all the required information.
- Refer to a corresponding GitHub issue in your PR description if applicable.
- Include sufficient design details for breaking changes or API changes in your description.
- Ensure that your PR passes all Continuous Integration (CI) tests before merging it.