Struct cargo_culture_kit::HasReadmeFile

pub struct HasReadmeFile;

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

Justification

A README file is likely the first and last piece of documentation people may read about a project.

Trait Implementations

impl Debug for HasReadmeFile

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

Formats the value using the given formatter.

impl Default for HasReadmeFile

fn default() -> HasReadmeFile

Returns the "default value" for a type.

impl Rule for HasReadmeFile

fn description(&self) -> &'static 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?