Skip to main content

Contributing a Taxonomy

Mandaitor thrives on community contributions. If your industry isn't represented yet, we encourage you to build and submit a new taxonomy. This guide, adapted from the mandaitor-taxonomies repository, outlines the process.

Quick Start​

  1. Fork & Clone: Fork the mandaitor-taxonomies repository.
  2. Install: Run pnpm install.
  3. Scaffold: Use the scaffolding script to create your new taxonomy package: 
    pnpm new-taxonomy <your-industry-id> "Your Industry Name"
  4. Define: Implement the actions, resources, constraints, and templates in the generated src files.
  5. Test: Run pnpm build && pnpm test to validate your taxonomy.
  6. Submit: Open a Pull Request against the main branch.

Design Principles​

  • Principle of Least Privilege: Default to restrictive permissions.
  • Granularity over Breadth: Prefer many specific actions over few broad ones.
  • Real-World Mapping: Actions should map to real operations in your industry.
  • Safety by Default: CRITICAL and HIGH risk actions must have appropriate human-in-the-loop controls.

For a complete guide, please refer to the CONTRIBUTING.md file in the taxonomies repository.