Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.83 KB

Contributing to noqta-gitlab-server

We welcome contributions to the GitLab MCP Server! Whether it's reporting a bug, suggesting an enhancement, or submitting a pull request, your help is appreciated.

How to Contribute

Reporting Bugs

If you encounter a bug, please open an issue on the GitHub repository. Include the following information:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • What you expected to happen.
  • What actually happened (including error messages or logs if applicable).
  • Your environment (OS, Node.js version, GitLab version if self-hosted).

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue on GitHub. Describe your suggestion clearly and explain why you think it would be valuable.

Pull Requests

  1. Fork the repository on GitHub.
  2. Clone your fork locally (git clone https://github.com/nooqta/custom-gitlab-server.git).
  3. Create a new branch for your changes (git checkout -b feature/your-feature-name or bugfix/issue-description).
  4. Make your changes. Ensure you follow the existing code style and add tests if applicable.
  5. Build the project (npm run build) to ensure it compiles correctly.
  6. Commit your changes with a clear commit message (git commit -m "feat: Add feature X" or fix: Resolve issue Y").
  7. Push your branch to your fork (git push origin feature/your-feature-name).
  8. Open a pull request from your fork's branch to the main branch of the nooqta/noqta-gitlab-server repository.
  9. Provide a clear description of your changes in the pull request.

Code Style

Please try to maintain the existing code style (TypeScript, formatting conventions). We may add linters/formatters in the future to automate this.

Thank you for contributing!