Contributing to MCP-GitLab¶

We welcome contributions from the community to improve the MCP-GitLab integration. This guide provides instructions on how to contribute effectively.

How Can You Contribute?¶

Reporting Bugs¶

Help us by reporting bugs using GitHub Issues.

Suggesting Features¶

We're always looking to improve! Suggest features by opening a new issue and including: - Description of the feature - Examples of use cases - Benefits and potential impacts

Submitting Pull Requests¶

1. Fork the repository and clone to your local machine.
   Bash

   git clone https://github.com/your-username/dev-mcp-gitlab
   

2. Create a new branch to work on your changes.
   Bash

   git checkout -b feature/new-feature
   

3. Make your changes, add tests, and ensure all existing tests pass.
4. Push your changes to your forked repository.
5. Submit a pull request with a detailed description of your changes.

Contribution Guidelines¶

Code Style¶

We adhere to a consistent code style for readability and maintainability. Please follow these guidelines: - Use 4 spaces for indentation - Use descriptive variable and function names - Include comments explaining complex logic

Testing¶

• Add tests for your new features or bug fixes
• Run all tests to ensure nothing is broken

# Run tests
npm test

Communication¶

• Join our Discord
• Follow us on Twitter

Acknowledgments¶

Thank you to all our contributors who help make this project better. We appreciate your efforts and commitment to open source.

Resources¶

• Getting Started Guide
• API Reference