Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.72 KB

Contributing to Quint Code

Workflow

  1. Create an issue first — Open an issue with the proposal label. Include:

    • Rationale — either FPF methodology alignment or UX improvement (feature request)
    • Question or problem statement
    • Proposed solution

  2. Wait for agreement — Do not create a PR until the proposal has been discussed and agreed upon in the issue.

  3. Check for existing work — Before starting, verify no one else has picked up the same issue. Comment on the issue to claim it.

  4. Create PR to dev branch — When ready, open a pull request targeting dev, not main. Link the original issue.

  5. Update the changelog — Add your changes to CHANGELOG.md under the [Unreleased] section.

Development Setup

# Clone and enter the project
git clone https://github.com/m0n0x41d/quint-code.git
cd quint-code

# Enable pre-commit hooks (mirrors CI pipeline exactly)
git config core.hooksPath .githooks

# Install golangci-lint (required for full lint checks)
# https://golangci-lint.run/welcome/install/
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin

# Build
cd src/mcp
go build -o ~/.local/bin/quint-code -trimpath .

# Run tests
go test -race ./...

The pre-commit hook runs the same checks as CI: go mod tidy, golangci-lint, go test -race, go build. If it fails, CI will fail too. Fix locally before pushing.

Want to Help but No Proposal?

Check existing issues labeled bug, documentation, or help wanted. Leave a comment to express interest and wait for approval before starting work.

Summary

Issue (proposal label) → Agreement → Claim issue → PR to dev → Update changelog