CONTRIBUTING.md•1.92 kB
# Contributing to LMStudio-MCP
Thank you for your interest in contributing to LMStudio-MCP! This document provides guidelines and instructions for contributing.
## Ways to Contribute
- **Bug reports**: Help identify issues with the bridge
- **Feature suggestions**: Propose new features or improvements
- **Model compatibility notes**: Share your experiences with different models
- **Documentation improvements**: Help improve or clarify the documentation
- **Code contributions**: Fix bugs or implement new features
## Reporting Issues
When reporting issues, please include:
- A clear description of the problem
- Steps to reproduce the issue
- The model(s) you were using when the issue occurred
- Any error messages or logs
- Your environment (OS, Python version, LM Studio version)
## Model Compatibility Database
We're building a database of model compatibility information. If you've tested LMStudio-MCP with specific models, please share your findings:
- Model name and version
- Whether it worked correctly
- Any specific parameters that improved performance
- Any limitations or issues encountered
## Pull Request Process
1. Fork the repository
2. Create a new branch for your changes
3. Make your changes
4. Test your changes thoroughly
5. Submit a pull request with a clear description of the changes
For significant changes, please open an issue first to discuss the proposed changes.
## Development Setup
1. Clone the repository
2. Install development dependencies:
```bash
pip install -e ".[dev]"
```
3. Make your changes
4. Test your changes with a local LM Studio instance
## Code Style
- Follow PEP 8 guidelines
- Use clear, descriptive variable and function names
- Add docstrings for functions and classes
- Include type hints where applicable
## License
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.