The quality_rules package

Summary

Submodules

cicd	CI/CD content checks.
common	Shared helpers for quality check rules.
project_metadata	Project metadata checks.
readme	README quality checks.

Functions

repo_review_checks

Return the registered rule instances for the requested families.

Constants

README_QUALITY_RULES
PROJECT_METADATA_QUALITY_RULES
CICD_QUALITY_RULES
RULE_FAMILIES
DEFAULT_RULE_FAMILIES

Description

Quality-check registry subpackage.

Module detail

quality_rules.repo_review_checks(families: collections.abc.Iterable[str] = DEFAULT_RULE_FAMILIES) → dict[str, ansys.pre_commit_hooks.quality_rules.common._QualityRule]

Return the registered rule instances for the requested families.

Parameters:

familiescollections.abc.Iterable[str], default: every family

Rule family names to include.

Returns:

dict[str, _QualityRule]

Rule instances keyed by their rule IDs.

quality_rules.README_QUALITY_RULES: tuple[type[ansys.pre_commit_hooks.quality_rules.readme.README], ...]

quality_rules.PROJECT_METADATA_QUALITY_RULES: tuple[type[ansys.pre_commit_hooks.quality_rules.project_metadata.ProjectMetadata], ...]

quality_rules.CICD_QUALITY_RULES: tuple[type[ansys.pre_commit_hooks.quality_rules.cicd.CICD], ...]

quality_rules.RULE_FAMILIES: dict[str, tuple[type[ansys.pre_commit_hooks.quality_rules.common._QualityRule], ...]]

quality_rules.DEFAULT_RULE_FAMILIES: tuple[str, ...]