Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (54 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 2.33 KB

Contributing to governance-sdk

Thanks for your interest in contributing! This guide covers everything you need to get started.

Development Setup

# Clone the repository
git clone https://github.com/lua-ai-global/governance.git
cd governance

# Install dependencies
npm install

# Build all packages
npm run build

# Run tests
npm test

# Type-check without emitting
npm run lint

Requirements

  • Node.js >= 20
  • TypeScript >= 5.7

Project Structure

packages/
  governance/          # Core SDK — policy enforcement, scoring, injection detection, framework adapters
  governance-platform/ # PostgreSQL storage layer — auto-migrating schema, org settings

Code Style

  • Files: kebab-case.ts
  • Functions/variables: camelCase
  • No any types — use proper TypeScript types throughout
  • < 300 LOC per file — split into modules if approaching limit
  • Zero runtime dependencies on the core SDK — never add to dependencies. Framework imports go in peerDependencies (optional).

Making Changes

  1. Fork the repository and create a feature branch
  2. Make your changes
  3. Run npm test — all tests must pass
  4. Run npm run build — must compile clean
  5. Submit a pull request

Adding a Framework Adapter

  1. Create src/plugins/framework-name.ts
  2. Import types only from the framework — never add to dependencies
  3. Create src/plugins/framework-name.test.ts with mock framework objects
  4. Add to package.json exports AND peerDependencies + peerDependenciesMeta
  5. Add to the framework table in README.md

Pull Request Guidelines

  • Keep PRs focused — one feature or fix per PR
  • Include tests for new functionality
  • Update documentation if the public API changes
  • Use imperative mood in commit messages (e.g., "Add rate limit policy", not "Added rate limit policy")

Reporting Issues

  • Bugs: Open a GitHub issue with steps to reproduce, expected vs. actual behavior, and your Node/SDK version
  • Security vulnerabilities: See SECURITY.md — do not open a public issue
  • Feature requests: Open a GitHub issue describing the use case

License

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