# Contributing to GitLab MCP Server Thank you for your interest in contributing to the GitLab MCP Server! We welcome contributions from the community. ## 🚀 Quick Start 1. **Fork the repository** on GitHub 2. **Clone your fork** locally 3. **Create a branch** for your changes: `git checkout -b feature/your-feature-name` 4. **Make your changes** following our standards 5. **Test your changes** thoroughly 6. **Commit** with clear, descriptive messages 7. **Push** to your fork 8. **Open a Pull Request** against the `main` branch --- ## 📋 Development Setup ### Prerequisites - Node.js 18+ and npm - GitLab account with Personal Access Token - Git ### Installation ```bash # Clone the repository git clone https://github.com/yoda-digital/mcp-gitlab-server.git cd mcp-gitlab-server # Install dependencies npm install # Build the project npm run build # Run tests npm test ``` ### Environment Setup Create a `.env` file (or export environment variables): ```bash GITLAB_PERSONAL_ACCESS_TOKEN=your-token-here GITLAB_API_URL=https://gitlab.com/api/v4 # or your GitLab instance API endpoint ``` --- ## 🎯 Areas We Welcome Contributions ### High Priority - **API Documentation** — Document tools with examples, parameters, and response formats - **Test Coverage** — Unit and integration tests for tools - **Bug Fixes** — Fix issues reported in GitHub Issues - **Performance Improvements** — Optimize API calls, caching, pagination ### Medium Priority - **New Tools** — Add missing GitLab API endpoints as MCP tools - **Error Handling** — Better error messages and validation - **Examples** — Real-world use cases and tutorials - **Type Safety** — Improve TypeScript types and schemas ### Future Features (v0.4.0+) - Enterprise features (SAML, OAuth3, audit logging) - Revolutionary features (Jira sync, changelog auto-gen, CI visualization) - Multi-language SDKs (Python, Go) --- ## 📝 Code Standards ### TypeScript Guidelines ```typescript // ✅ Good async function createIssue( projectId: string, title: string, description?: string ): Promise { // Implementation } // ❌ Bad async function createIssue(projectId: any, title: any, description: any): Promise { // Implementation } ``` **Rules:** - Use **strict TypeScript** — no `any` types - **camelCase** for variables and functions - **PascalCase** for classes, interfaces, types - **UPPER_SNAKE_CASE** for constants - **JSDoc comments** for public APIs with `@param`, `@returns`, `@throws` ### Commit Message Format Follow [Conventional Commits](https://www.conventionalcommits.org/): ``` ():