Pactpact

Contributing

How to contribute to Pact development

Contributing

We welcome contributions to Pact!

Prerequisites

  • Go 1.21+ for CLI development
  • Node.js 18+ for web app development
  • A GitHub OAuth App for authentication testing

Getting Started

Clone the Repository

git clone https://github.com/cloudboy-jh/pact.git
cd pact

Building the CLI

cd cli
go mod tidy
go build -o pact .
./pact --help

Running the Web App

cd web
npm install
npm run dev

Project Structure

pact/
├── cli/                    # Go CLI
│   ├── cmd/                # Cobra commands
│   ├── internal/           # Internal packages
│   ├── go.mod
│   └── main.go
├── web/                    # SvelteKit web app
│   ├── src/
│   ├── package.json
│   └── svelte.config.js
├── docs/
│   ├── ARCHITECTURE.md
│   └── ROADMAP.md
└── README.md

Submitting Changes

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Open a Pull Request

On this page