@codesys/mcp-toolkit
Version:
Model Context Protocol (MCP) server for CODESYS automation platform
73 lines (51 loc) • 1.95 kB
Markdown
# Contributing to @codesys/mcp-toolkit
Thank you for considering contributing to the CODESYS MCP Toolkit! This document provides guidelines and steps for contributing.
## Code of Conduct
Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
## How Can I Contribute?
### Reporting Bugs
Bug reports help improve the project! When reporting bugs:
1. Check if the bug has already been reported
2. Use the bug report template
3. Include detailed steps to reproduce the issue
4. Describe the expected vs. actual behavior
5. Include screenshots if applicable
6. Provide environment details (OS, Node.js version, etc.)
### Suggesting Features
We welcome feature suggestions! When suggesting features:
1. Describe the problem your feature would solve
2. Explain how your feature would work
3. Consider potential alternatives
4. Provide examples of similar features in other projects (if applicable)
### Pull Requests
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run tests and ensure they pass
5. Commit your changes (`git commit -m 'Add amazing feature'`)
6. Push to your branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request
## Development Setup
1. Clone the repository
```bash
git clone https://github.com/yourusername/codesys-mcp-toolkit.git
cd codesys-mcp-toolkit
```
2. Install dependencies
```bash
npm install
```
3. Build the project
```bash
npm run build
```
## Style Guidelines
- Follow existing code formatting patterns
- Use meaningful variable and function names
- Add comments where necessary to explain complex logic
- Update documentation when changing functionality
## Testing
- Add tests for new features
- Ensure all tests pass before submitting a PR
- Consider edge cases in your tests
Thank you for contributing!