Skip to content

Contributing

Thank you for your interest in contributing to Pumbaa! ❤

🔧 Development Setup

Prerequisites

  • Go 1.21+
  • Make

Build

git clone https://github.com/lmtani/pumbaa
cd pumbaa
make build

Binary Location

./dist/pumbaa

Run

./dist/pumbaa --help

🧪 Testing

make test

📁 Project Structure

pumbaa/
├── cmd/cli/            # CLI entry point
├── internal/
│   ├── application/    # Use cases
│   ├── container/      # Dependency injection
│   ├── domain/         # Domain entities
│   ├── infrastructure/ # External integrations (Cromwell, LLM, etc.)
│   └── interfaces/     # CLI & TUI handlers
└── pkg/wdl/            # WDL parser (ANTLR)

🚀 Pull Requests

  1. 🍴 Fork the repository
  2. 🌱 Create a feature branch
  3. 📝 Make your changes
  4. ✅ Run tests: make test
  5. 📥 Submit PR

🐛 Reporting Bugs

Found a bug? Open an issue

Please include:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Your environment (OS, Cromwell version, pumbaa version)
  • Relevant logs or error messages

💡 Requesting Features

Have an idea? Open a feature request

Please include:

  • A clear description of the feature
  • Why it would be useful
  • Any examples or mockups if applicable

All contributions welcome!

All contributions and feedback are welcome! Please ensure issues include enough details for us to investigate or implement your request.