Thank you for your interest in contributing to Pocket-RAG.
We welcome contributions of all kinds, whether they are bug fixes, improvements, or new features. To keep the project clean and maintainable, please follow the guidelines below.
Please follow conventional commit standards when writing commit messages. This helps keep the project history clear and consistent.
Examples:
- feat: add new feature
- fix: resolve bug
- docs: update documentation
- refactor: improve code structure
Make sure your commit messages are descriptive and meaningful.
Before opening a pull request, ensure that your changes have been properly tested.
Your contribution should not break existing functionality.
If your changes may impact the architecture or introduce significant modifications, please open a discussion before starting implementation.
This helps avoid unnecessary conflicts and ensures consistency across the project.
We encourage clean, readable, and well-structured code.
We generally encourage documenting your changes through comments in your code. This helps others understand your logic and improves long-term maintainability.
When submitting a pull request:
- Ensure your code follows the project structure
- Provide a clear description of your changes
- Reference related issues if applicable
Contributions are strongly encouraged and appreciated. Every improvement, no matter how small, helps make the project better.
Thank you for contributing.