Struct ProjectConventions 

pub struct ProjectConventions {
    pub commit_format: Option<String>,
    pub required_trailers: Vec<String>,
    pub preferred_types: Vec<String>,
    pub scope_requirements: ScopeRequirements,
}

Project conventions parsed from documentation.

Fields

commit_format: Option<String>

Expected commit message format.

required_trailers: Vec<String>

Required trailers like Signed-off-by.

preferred_types: Vec<String>

Preferred commit types for this project.

scope_requirements: ScopeRequirements

Scope usage requirements and definitions.

Trait Implementations

impl Clone for ProjectConventions

fn clone(&self) -> ProjectConventions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectConventions

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

Formats the value using the given formatter.

impl Default for ProjectConventions

fn default() -> ProjectConventions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProjectConventions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProjectConventions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.