Contributing

We welcome contributions to guardrail-sim! Here's how to get started.

Development Setup

# Clone the repo
git clone https://github.com/jeffgreendesign/guardrail-sim
cd guardrail-sim
 
# Install dependencies
pnpm install
 
# Run tests
pnpm test
 
# Start development
pnpm dev

Project Structure

guardrail-sim/
├── packages/
│   ├── policy-engine/    # Core policy engine
│   ├── mcp-server/       # MCP server with 5 tools
│   ├── ucp-types/        # UCP type definitions
│   ├── insights/         # Policy health checks
│   └── simulation/       # LLM buyer simulation [PLANNED]
├── apps/
│   └── website/          # Documentation site + playground
└── docs/                 # MDX content

Running Tests

# All tests
pnpm test
 
# With coverage
pnpm test:coverage
 
# Single package
pnpm --filter @guardrail-sim/policy-engine test

Code Style

We use ESLint and Prettier for formatting
Run pnpm lint to check for issues
Run pnpm format to auto-format
TypeScript strict mode is required
Explicit return types on exported functions

Submitting Changes

Fork the repository
Create a feature branch (git checkout -b feature/my-feature)
Make your changes
Run pnpm lint && pnpm typecheck && pnpm test to ensure quality
Commit with a descriptive message (we use conventional commits)
Push and open a Pull Request

Commit Messages

We follow Conventional Commits:

feat: add new constraint type for time windows
fix: correct margin calculation for volume discounts
docs: update getting started guide
chore: update dependencies

Contributing

Contributing

Development Setup

Project Structure

Running Tests

Code Style

Submitting Changes

Commit Messages

On this page