PM004#

class src.ansys.pre_commit_hooks.quality_rules.project_metadata.PM004#

Bases: ProjectMetadata

The CONTRIBUTING.md file exists.

Overview#

check

Return whether the contributing guide is present.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.project_metadata import PM004

Method detail#

static PM004.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#

Return whether the contributing guide is present.