CONTRIBUTING.md•2.86 kB
# Contributing to Debug-MCP
Thank you for your interest in contributing to Debug-MCP! This document provides guidelines for contributing to the project.
## Getting Started
1. **Fork the Repository**: Fork the Debug-MCP repository to your GitHub account.
2. **Clone Your Fork**:
```bash
git clone https://github.com/YOUR-USERNAME/Debug-MCP.git
cd Debug-MCP
```
3. **Set Up Development Environment**:
```bash
# Create virtual environment
uv venv
# Install dependencies
uv pip install -e ".[dev,cli]"
```
4. **Create a Branch**:
```bash
git checkout -b feature/your-feature-name
```
## Development Workflow
### Running Tests
```bash
# Run all tests
uv run pytest
# Run only unit tests
uv run pytest tests/unit/
# Run with coverage
uv run pytest --cov=src/mcp_debug_tool --cov-report=html
```
### Code Quality
```bash
# Lint code
uv run ruff check .
# Auto-fix lint issues
uv run ruff check --fix .
# Format code
uv run ruff format .
```
### Testing Your Changes
Before submitting a pull request, ensure:
- All tests pass
- Code follows the project's style guide
- New features have appropriate tests
- Documentation is updated
## Submitting Changes
1. **Commit Your Changes**:
```bash
git add .
git commit -m "Brief description of your changes"
```
2. **Push to Your Fork**:
```bash
git push origin feature/your-feature-name
```
3. **Open a Pull Request**:
- Go to the Debug-MCP repository on GitHub
- Click "Pull Request"
- Select your fork and branch
- Provide a clear description of your changes
## Pull Request Guidelines
- **Title**: Use a clear, descriptive title
- **Description**: Explain what changes you made and why
- **Tests**: Include tests for new features
- **Documentation**: Update relevant documentation
- **Code Style**: Follow existing code conventions
## Code Style
- Follow PEP 8 guidelines
- Use type hints where appropriate
- Write clear, descriptive variable and function names
- Add docstrings to public functions and classes
- Keep functions focused and small
## Reporting Issues
When reporting issues, please include:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Your environment (OS, Python version, etc.)
- Relevant logs or error messages
## Feature Requests
We welcome feature requests! Please:
- Check if the feature has already been requested
- Provide a clear use case
- Explain how it would benefit users
## Questions?
If you have questions about contributing, feel free to:
- Open an issue with the "question" label
- Reach out to the maintainers
## Code of Conduct
Please be respectful and constructive in all interactions with the community.
## License
By contributing to Debug-MCP, you agree that your contributions will be licensed under the MIT License.