MokoCLI/mcp/servers/mokossh/CONTRIBUTING.md

Contributing to MCP SSH Manager

First off, thank you for considering contributing to MCP SSH Manager! It's people like you that make this tool better for everyone.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

• Use a clear and descriptive title
• Describe the exact steps to reproduce the problem
• Provide specific examples
• Describe the behavior you observed and expected
• Include logs and error messages
• Include your environment details (OS, Node.js version, Python version)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

• Use a clear and descriptive title
• Provide a detailed description of the suggested enhancement
• Provide specific examples to demonstrate the enhancement
• Describe the current behavior and expected behavior
• Explain why this enhancement would be useful

Pull Requests

1. Fork the repo and create your branch from main
2. If you've added code that should be tested, add tests
3. Ensure the test suite passes
4. Make sure your code follows the existing code style
5. Write a clear commit message

Development Process

1. Clone your fork:

   git clone https://github.com/your-username/mcp-ssh-manager.git
   cd mcp-ssh-manager
   

2. Install dependencies:

   npm install
   pip install -r tools/requirements.txt
   

3. Create a branch:

   git checkout -b feature/your-feature-name
   

4. Make your changes and test them

5. Commit your changes:

   git add .
   git commit -m "Add your descriptive commit message"
   

6. Push to your fork:

   git push origin feature/your-feature-name
   

7. Open a Pull Request

Style Guidelines

JavaScript Style

• Use ES6+ features
• Use async/await for asynchronous code
• Add JSDoc comments for functions
• Use meaningful variable names

Python Style

• Follow PEP 8
• Use type hints where appropriate
• Add docstrings to functions and classes
• Use meaningful variable names

Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Testing

Before submitting a pull request:

1. Test your changes manually
2. Ensure existing functionality still works
3. Test with different server configurations
4. Verify Claude Code integration works

Documentation

• Update README.md if you change functionality
• Add JSDoc/docstrings for new functions
• Update examples if needed
• Keep documentation clear and concise

Questions?

Feel free to open an issue with your question or reach out to the maintainers.

Thank you for contributing! 🎉