Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (84 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

112 lines (84 loc) · 3.07 KB

Contributing to RAG_Ollama_Mac

Thank you for your interest in contributing to RAG_Ollama_Mac! This document provides guidelines for contributing to the project.

🤝 How to Contribute

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check existing issues to avoid duplicates
  2. Create a new issue with a clear title and description
  3. Include details such as:
    • Your operating system and Python version
    • Steps to reproduce the issue
    • Expected vs. actual behavior
    • Screenshots if applicable

Submitting Changes

  1. Fork the repository to your GitHub account
  2. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  3. Make your changes following the code style guidelines below
  4. Test your changes thoroughly
  5. Commit your changes with clear, descriptive messages: 
    git commit -m "Add feature: description of your changes"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request with a clear description of your changes

📝 Code Style Guidelines

Python Code

  • Follow PEP 8 style guide
  • Use meaningful variable and function names
  • Add docstrings for functions and classes
  • Keep functions focused and modular
  • Comment complex logic when necessary

Code Structure

  • Keep related functionality together
  • Maintain separation of concerns
  • Avoid duplicating code

🧪 Testing

  • Test your changes with different PDF documents
  • Verify the chatbot responses are appropriate
  • Check that document loading works correctly
  • Ensure the UI displays properly

📚 Documentation

When adding new features:

  • Update README.md if necessary
  • Add comments to explain complex code
  • Update CHANGELOG.md following the existing format
  • Consider adding examples or usage instructions

🎯 Areas for Contribution

We welcome contributions in these areas:

Features

  • Support for additional file formats (Markdown, .txt, HTML, DOCX)
  • Additional LLM model configurations
  • Chat history persistence
  • Document management interface
  • Enhanced search and retrieval options
  • User settings and preferences

Improvements

  • Performance optimizations
  • Better error handling
  • Improved UI/UX
  • Enhanced documentation
  • Code refactoring
  • Test coverage

Documentation

  • Tutorial videos or guides
  • Use case examples
  • Troubleshooting tips
  • Translation to other languages

🔍 Code Review Process

All submissions require review. We use GitHub pull requests for this purpose. The review process includes:

  1. Code quality and style check
  2. Functionality verification
  3. Documentation completeness
  4. Potential impact assessment

📜 License

By contributing to RAG_Ollama_Mac, you agree that your contributions will be licensed under the MIT License.

💬 Questions?

Feel free to open an issue for any questions about contributing!

🙏 Thank You!

Your contributions help make RAG_Ollama_Mac better for everyone. We appreciate your time and effort!