This is a monorepo. It contains apps and packages organized as workspaces.
| Name | Description |
|---|---|
| website | User documentation website. |
| Name | Description |
|---|---|
| action | The GitHub action |
| functions | A set of functions that facilitate advanced rules for validation of model card documents |
| jest-presets | Shared Jest presets |
| mlflow | MLflow integration |
| rulesets | Loads the custom rulesets |
| types | Common types |
| tsconfig | Shared Typescript configurations |
Install node, the minimum version is 18. If you have nvm installed, execute nvm use and it'll pick the right version for you.
IDE / Editor of your choice - we use VSCode.
The build system relies on Turborepo.
Tests are run via the Jest test runner.
npm run test -- --filter actionBuilding the action:
npx turbo run dev --filter actionWe want to keep issues in this repo focused on bug reports and feature requests.
Before you open an issue, please search to see if anyone else has already opened an issue that might be similar to yours.
For help, discussions, or "how-to" type questions, please use GitHub Discussions. If you are unsure if you are experiencing a bug then this is also a great place to start, as a discussion can be turned into an issue easily.
If you have found a security issue, please email hello@compliancepal.eu directly.