Skip to main content
We welcome contributions to mcpjungle. If you want to contribute code, docs, bug reports, or product ideas, this page covers the expected workflow and standards.

​
Before making significant changes

Before opening a large or significant pull request:
  1. Open a GitHub Discussion or Issue first to align on the direction.
  2. Avoid sending large amounts of code in a single PR.
For any code you generate with AI tools, make sure you:
  1. Run it and confirm it behaves correctly.
  2. Run tests and confirm they pass.
  3. Review it yourself and reduce it where possible.

​
Making changes

​
Documentation

  • Update documentation for any change to APIs, CLIs, or user-facing features
  • Add examples for new features where useful
  • Update the README when needed
  • Add comments only where they help explain non-obvious logic

​
Pull request process

  1. Update your fork from upstream:
git fetch upstream
git rebase upstream/main
  1. Push your branch:
git push origin feature/your-feature-name
  1. Open a pull request to the main repository.
  2. Write a clear PR description.
  3. Address review comments if maintainers request changes.
If you need to update your PR: 
git add .
git commit -m "address review comments"
git push origin feature/your-feature-name

​
Dependency policy

  • go.mod and go.sum are the source of truth for dependencies
  • vendor/ is not committed
  • For offline builds, you may run go mod vendor locally, but do not commit the result
  • CI and Docker builds should use module-aware mode and the Go proxy

​
Releases

Only repository owners create releases. Current release expectations:
  1. Releases are cut from main
  2. A tag is created for the release
  3. Artifacts are built and published with goreleaser
  4. Each release includes a changelog of merged PRs since the last release

​
Community

​
Development guide

For local setup, builds, testing, database workflows, and deeper implementation details, see the Development guide.

​
License

By contributing to this project, you agree that your contributions are licensed under the project’s license.