Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (56 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 2.54 KB
Raw

Contributing to CausalLayer MCP

Thank you for your interest in contributing to CausalLayer! This document provides guidelines and information for contributors.

Quick Start

# Clone the repository
git clone https://github.com/smq9sn5jck-coder/causallayer-mcp.git
cd causallayer-mcp

# Install dependencies
npm install

# Run tests
npm test

# Start local development
npx wrangler dev

How to Contribute

Reporting Bugs

  • Use GitHub Issues
  • Include steps to reproduce, expected vs actual behavior
  • Include your environment (OS, Node.js version, Wrangler version)

Suggesting Features

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (npm test)
  5. Commit with conventional commits (feat:, fix:, docs:, etc.)
  6. Push to your fork and open a PR

Areas We Need Help

Check our roadmap issues for areas where contributions are especially welcome:

  • 🌏 Jurisdiction modules — Add regulatory mappings for new countries/regions
  • 🧪 Test scenarios — Industry-specific incident templates
  • 📖 Documentation — Tutorials, integration guides, translations
  • 🔌 Client integrations — Claude Desktop, Cursor, VS Code configurations
  • 📊 Scoring models — New attribution algorithms and weighting schemes

Code Style

  • TypeScript strict mode
  • ESLint + Prettier (run npm run lint)
  • Meaningful variable names over comments
  • Each MCP tool should be self-contained in its own module

Commit Messages

We follow Conventional Commits:

feat: add Japanese jurisdiction module
fix: correct liability split rounding error
docs: add Claude Desktop integration guide
test: add edge case for multi-party incidents
chore: update wrangler to v4

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Questions?