Futurama Quote Machine MCP Server

# Contributing to Futurama Quote Machine MCP Server Thank you for your interest in contributing! This project welcomes contributions from developers of all skill levels. ## Quick Start for Contributors 1. **Fork the repository** on GitHub 2. **Clone your fork** locally: ```bash git clone https://github.com/YOUR-USERNAME/futurama-quote-machine-mcp.git cd futurama-quote-machine-mcp ``` 3. **Set up development environment**: ```bash python3 -m venv venv source venv/bin/activate # Windows: venv\Scripts\activate pip install mcp httpx ``` 4. **Test that everything works**: ```bash ./run_server.sh # Windows: run_server.bat ``` ## How to Contribute ### Reporting Issues - **Found a bug?** [Create an issue](../../issues/new) with: - Your operating system - Python version (`python --version`) - Steps to reproduce the bug - Expected vs actual behavior - **Have a feature idea?** [Start a discussion](../../discussions) first to get feedback ### Making Changes 1. **Create a branch** for your feature: ```bash git checkout -b feature/your-feature-name ``` 2. **Make your changes**: - Follow the existing code style - Add comments for complex logic - Test your changes thoroughly 3. **Test your changes**: - Test the server starts without errors - Test with Claude Desktop if possible - Verify all existing functionality still works 4. **Commit your changes**: ```bash git add . git commit -m "Add feature: your feature description" ``` 5. **Push to your fork**: ```bash git push origin feature/your-feature-name ``` 6. **Create a Pull Request** on GitHub ## Development Guidelines ### Code Style - **Python**: Follow PEP 8 style guidelines - **Comments**: Use clear, concise comments for complex logic - **Docstrings**: Add docstrings for all functions - **Type hints**: Use type hints where helpful ### Testing - **Manual testing**: Test the server with Claude Desktop - **Error handling**: Ensure graceful error handling - **Cross-platform**: Test on both Windows and macOS/Linux if possible ### Documentation - **Update README.md** if you add new features - **Update installation scripts** if dependencies change - **Add usage examples** for new features ## Ideas for Contributions Here are some ways you can help improve this project: ### 🐛 Bug Fixes - Fix installation issues on different platforms - Improve error messages - Handle edge cases better ### ✨ New Features - Support for additional quote operations - Integration with other quote APIs - Better search capabilities - Quote categories or tags ### 📚 Documentation - Improve beginner-friendly instructions - Add video tutorials - Better troubleshooting guides - Translation to other languages ### 🔧 Developer Experience - Better development setup scripts - Automated testing - Code quality tools - Performance improvements ### 🎨 User Experience - Better error messages - More natural language processing - Improved quote formatting - Additional output formats ## Getting Help - **Questions about the code?** [Start a discussion](../../discussions) - **Need help with setup?** Check the [troubleshooting section](README.md#troubleshooting) - **Want to chat?** Join the discussions and introduce yourself! ## Code Review Process 1. **Automated checks**: We may add automated checks in the future 2. **Manual review**: Maintainers will review your code for: - Functionality - Code quality - Documentation - Compatibility 3. **Feedback**: You may receive suggestions for improvements 4. **Approval**: Once approved, your changes will be merged ## Recognition Contributors will be: - Listed in the project's contributor list - Credited in release notes for significant contributions - Given credit in documentation for major features ## Code of Conduct Please be respectful and constructive in all interactions. This is a learning-friendly environment where questions and suggestions are welcome. ### Our Standards - **Be welcoming** to newcomers and experienced developers alike - **Be respectful** of different viewpoints and experiences - **Focus on what's best** for the community and project - **Use inclusive language** in all communications ### Not Acceptable - Harassment or discriminatory behavior - Trolling or insulting comments - Personal attacks - Publishing private information without permission ## Questions? Don't hesitate to ask questions! You can: - [Create an issue](../../issues/new) for bugs or feature requests - [Start a discussion](../../discussions) for general questions - Comment on existing issues or pull requests Thank you for contributing to the Futurama Quote Machine MCP Server! 🚀