快速入门

1. 将crate添加到您的 Cargo.toml

   cargo install cargo-edit
   
   cargo add conventional
   

2. 导入 Commit 类型以及 Simple 特性以解析提交字符串，并查询其不同组件作为字符串切片

   use conventional::{Commit, Simple as _};
   
   let commit = Commit::new("feat(conventional commit): this is it!").unwrap();
   
   assert_eq!("feat", commit.type_());
   assert_eq!("conventional commit", commit.scope());
   assert_eq!("this is it!", commit.description());
   assert_eq!(None, commit.body());
   

3. 升级到 Typed 组件以进行强类型访问

   use conventional::{Commit, Typed as _};
   
   let commit = Commit::new("feat(conventional commit): this is it!").unwrap();
   
   assert_eq!(Type("feat"), commit.type_());
   

4. 查看如 Jilu 的示例以了解库的使用。