Contributing
June 29, 2026 · View on GitHub
We welcome pull requests and issues on GitHub.
Full guide (setup, commits, releases, PR checklist): docs/contributing/contribution_guide.mdx · docs.page
Contributor links
- Contributor credit: docs/contributing/contributors.mdx
- Docs maintenance: docs/contributing/docs_maintenance.mdx
- Code of conduct: CODE_OF_CONDUCT.md
- Security reporting: SECURITY.md
Maintainers
Release legibility (cross-repo contract)
Product harness releases should keep changelog in git and binaries aligned with the tag. The normative pattern lives in Skill Steward:
- Skill:
release-changelog-harness— install:npx skills add arenukvern/skill_steward --skill release-changelog-harness - Reference: binary-release-contract.md
- ADR (meta vs product): ADR 0010 — binary releases for product harness
mcp_flutter is the reference implementation: release-please on main, tag-triggered artifacts, consumer install.sh without a full clone.
Binary release train (this repo)
| Step | Where |
|---|---|
| Version + changelog PR | release-please → merge Release PR → tag vX.Y.Z |
| Build tarballs | .github/workflows/release.yml or locally make release-artifacts → tool/release/build_release_artifacts.sh |
| Outputs | dist/release/flutter_mcp_<version>_<triple>.tar.gz + dist/release/checksums.txt (SHA-256 per tarball) |
| Attach to GitHub Release | CI on tag (same filenames as checksums.txt entries) |
Before merge, run make check-contracts (check_version_sync.sh, skill assets drift). Bundled skill: flutter-mcp-toolkit-repo-maintainer (.cursor/skills/flutter-mcp-toolkit-repo-maintainer).
Consumer install + checksum verification (install.sh)
End users should install from GitHub Release assets, not git clone:
curl -fsSL https://raw.githubusercontent.com/Arenukvern/mcp_flutter/main/install.sh | bash
# pinned:
curl -fsSL https://raw.githubusercontent.com/Arenukvern/mcp_flutter/main/install.sh | bash -s -- --version vX.Y.Z
Checksum flow (maintainers: keep CI and install.sh in sync):
- Download
flutter_mcp_<version>_<triple>.tar.gzfromhttps://github.com/Arenukvern/mcp_flutter/releases/download/v<version>/. - Download
checksums.txtfrom the same release URL. - Find the line for the archive:
sha256sum_value flutter_mcp_<version>_<triple>.tar.gz. - Compute SHA-256 locally (
sha256sumorshasum -a 256) and compare;install.shaborts on mismatch. - Extract tarball and install
bin/flutter-mcp-toolkitandbin/flutter-mcp-toolkit-serverto$HOME/.local/bin(or--install-dir).
Published triples: darwin-arm64, linux-x64 only. Intel macOS is unsupported for published binaries (install from source).
When changing artifact names or checksum layout, update tool/release/build_release_artifacts.sh, install.sh, and .github/workflows/release.yml in the same PR.