vibe-llama/CONTRIBUTING.md

Contributing to vibe-llama

Thank you for your interest in contributing to this project! Please review these guidelines before getting started.

Issue Reporting

When to Report an Issue

• You've discovered bugs but lack the knowledge or time to fix them
• You have feature requests but cannot implement them yourself

⚠️ Important: Always search existing open and closed issues before submitting to avoid duplicates.

How to Report an Issue

1. Open a new issue
2. Provide a clear, concise title that describes the problem or feature request
3. Include a detailed description of the issue or requested feature

Code Contributions

When to Contribute

• You've identified and fixed bugs
• You've optimized or improved existing code
• You've developed new features that would benefit the community

How to Contribute

1. Fork the repository and checkout a feature branch

2. Set up pre-commit hooks

   pip install pre-commit
   pre-commit install
   

3. Make your changes and test

   pytest tests/
   

   Ensure all tests pass. Add tests for new features.

4. Commit your changes

5. Verify pre-commit compliance Ensure your changes pass all linting checks.

6. Submit a pull request Include a comprehensive description of your changes.

---

Thank you for contributing!