Oura Ring MCP Server

# Contributing to Oura MCP Python Thank you for your interest in contributing to the Oura MCP Python server! This document provides guidelines and instructions for contributing. ## Code of Conduct Be respectful, inclusive, and professional in all interactions. ## How to Contribute ### Reporting Bugs Before creating a bug report: 1. Check existing issues to avoid duplicates 2. Verify you're using the latest version 3. Test with minimal configuration Include in your bug report: - Python version - Operating system - Steps to reproduce - Expected vs actual behavior - Relevant logs or error messages ### Suggesting Features Feature requests are welcome! Please: - Check if the feature already exists - Explain the use case - Describe the proposed solution - Consider implementation complexity ### Pull Requests 1. **Fork the repository** ```bash git clone https://github.com/yourusername/oura-mcp-python.git cd oura-mcp-python ``` 2. **Create a feature branch** ```bash git checkout -b feature/your-feature-name ``` 3. **Make your changes** - Follow the code style guidelines - Add tests for new features - Update documentation 4. **Run tests and linting** ```bash pytest black server.py ruff check server.py ``` 5. **Commit your changes** ```bash git commit -m "Add feature: description" ``` 6. **Push and create PR** ```bash git push origin feature/your-feature-name ``` ## Development Setup ### Local Development ```bash # Create virtual environment python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate # Install dependencies pip install -r requirements.txt pip install -e ".[dev]" # Copy environment template cp .env.example .env # Add your OURA_PERSONAL_ACCESS_TOKEN to .env # Run the server python server.py ``` ### Code Style - Follow PEP 8 guidelines - Use type hints - Maximum line length: 100 characters - Use Black for formatting - Use Ruff for linting ### Testing Run tests before submitting: ```bash pytest tests/ -v ``` Add tests for new features in `tests/` directory. ## Project Structure ``` oura-mcp-python/ ├── server.py # Main server implementation ├── requirements.txt # Production dependencies ├── pyproject.toml # Project configuration ├── tests/ # Test files ├── docs/ # Additional documentation └── examples/ # Usage examples ``` ## Release Process Maintainers will: 1. Review and merge PRs 2. Update version in `pyproject.toml` 3. Create release notes 4. Tag release 5. Publish to PyPI (if applicable) ## Questions? Open an issue for questions or discussions about contributions. Thank you for contributing!