Struct cargo_culture_kit::HasContributingFile

pub struct HasContributingFile;

Rule that asserts a good Rust project: "Should have a CONTRIBUTING file in the project directory."

Justification

A CONTRIBUTING file is a starting point for would-be collaborators popularized in the open-source world. Even for closed-source projects, a CONTRIBUTING file can be a gateway to developer-focused guidance, and thus useful for on-boarding in a more targeted manner than the general README.

Trait Implementations

impl Debug for HasContributingFile

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for HasContributingFile

fn default() -> HasContributingFile

Returns the "default value" for a type.

impl Rule for HasContributingFile

fn description(&self) -> &str

The central tenet of this Rule. Serves as a unique identifier for Rule instances, as well as a human-readable summary of what this Rule means for a given project.

fn evaluate(&self, context: RuleContext) -> RuleOutcome

Does the Rust project found at cargo_manifest_path uphold this Rule, as summarized in the description?