CONTRIBUTING.md•1.56 kB
# Contributing to OpenAPI MCP Server
Contributions to the OpenAPI MCP Server are welcome! By participating in this project, you agree to abide by our community guidelines and code standards.
## How to Contribute
1. **Fork & Clone**
Fork the repository on GitHub and clone it to your local machine.
2. **Create a Feature Branch**
Create a new branch for your feature or bug fix:
```bash
git checkout -b feature/my-new-feature
```
3. **Make Changes**
- Follow the existing code style and best practices (e.g., TypeScript best practices).
- Add or update tests where necessary.
- Ensure your changes do not break existing functionality.
4. **Run Tests & Linting**
Before submitting your pull request, run:
```bash
npm run typecheck
npm run lint
```
5. **Submit a Pull Request**
Once your changes are ready, open a pull request against the main branch. In your PR, please include:
- A clear description of your changes.
- References to any related issues.
- Any additional context necessary to understand the changes.
## Reporting Issues
If you encounter bugs or have feature requests, please:
- Open an issue on GitHub.
- Provide detailed steps to reproduce the issue if applicable.
- Include relevant logs or screenshots to help diagnose the problem.
## Communication
For questions or further discussion, feel free to join our community on GitHub Discussions or reach out via our project's preferred communication channels.
Thank you for helping improve the OpenAPI MCP Server!