Natty Precise Maverick

    @xiaoman/commitlint-config

    0.2.0 • Public • Published

    commit message guide

    git commit.template

    # commit log 請遵造以下格式,並注意冒號後面有一個空格
    # 
    # <type>: <subject> {必要}
    # 
    # <body> {非必要}
    # 
    # <footer> {非必要}
    # 
    # 範例
    # feat: implementation login api function
    #
    # finished login module and integration with server login api
    #
    # Closes OR-xxxx 
    # 
    # <Type>
    # 請遵守下列標籤
    # feat: 新功能
    # fix: Bug修復
    # docs: 文檔改變
    # style: 代碼格式改變
    # refactor: 功能重構
    # perf: 性能優化
    # test: 增加測試代碼
    # build: 改變build工具
    # ci: 與ci相關的設定
    # chore: 杂项
    # revert: git revert
    # wip: 进行中
    # workflow: 工作流
    # types: 类型相关
    # release: 发布相关
    # 
    # <Subject>
    # 用來簡要描述影響本次變動,概述即可, 不超过108字符
    # 
    # <Body>
    # 具體的修改訊息,越詳細越好
    # 
    # <Footer>
    # 如果是要關閉特定 Issue 或 Bug. 可以使用 Closes PROJECT-1 or Resolves PROJECT-1 or Fixes PROJECT-1 
    
    

    设定 git commit template 到全局

    cd ~
    
    vim .gitmessage.txt // 写入上面模版内容
    
    git config --global commit.template ~/.gitmessage.txt

    一些疑难杂症

    1. husky 在 sourcetree 不生效

    https://typicode.github.io/husky/#/?id=command-not-found

    Keywords

    none

    Install

    npm i @xiaoman/commitlint-config

    DownloadsWeekly Downloads

    10

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    6.91 kB

    Total Files

    4

    Last publish

    Collaborators

    • xavierluo
    • xiaoman-fe