CONTRIBUTING.md•1.96 kB
# Contributing to MCP Terminal Server
Thank you for considering contributing to the MCP Terminal Server project! This document provides guidelines and instructions for contributing.
## Code of Conduct
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
## How Can I Contribute?
### Reporting Bugs
- Check if the bug has already been reported in the [Issues](https://github.com/cwmoore-ai/mcp-terminal-server/issues)
- Use the bug report template when creating a new issue
- Include detailed steps to reproduce the bug
- Include information about your environment (OS, Python version, etc.)
### Suggesting Features
- Check if the feature has already been suggested in the [Issues](https://github.com/cwmoore-ai/mcp-terminal-server/issues)
- Use the feature request template when creating a new issue
- Clearly describe the feature and its benefits
### Pull Requests
1. Fork the repository
2. Create a new branch for your feature or bugfix (`git checkout -b feature/your-feature` or `git checkout -b fix/your-bugfix`)
3. Make your changes
4. Run tests to ensure your changes don't break existing functionality
5. Commit your changes with clear, descriptive commit messages
6. Push to your branch
7. Submit a pull request to the `main` branch
## Development Setup
1. Clone the repository
2. Install dependencies: `pip install -r requirements.txt`
3. Run tests to ensure everything is working correctly
## Coding Standards
- Follow PEP 8 style guidelines for Python code
- Write clear, descriptive comments
- Include docstrings for functions and classes
- Write tests for new functionality
## Testing
- Run existing tests before submitting a pull request
- Add new tests for new functionality
- Ensure all tests pass
## Documentation
- Update documentation when changing functionality
- Use clear and concise language
- Include examples where appropriate
Thank you for your contributions!