search

Home >Java >javaTutorial >What are the usage specifications of Java Git Commit Message?

What are the usage specifications of Java Git Commit Message?

WBOY
WBOYforward
2023-05-11 09:46:051576browse

    1. The format of the Commit message

    For each submission, the Commit message includes three parts: Header, Body and Footer. 

    <type>(<scope>): <subject>
// 空一行
<body>

    Among them, Header, submission content Body for feat and fix types are required. Regardless of the section, no line must exceed 72 characters (or 100 characters). This is to prevent automatic line wrapping from affecting the appearance.

    1.1 Header

    The Header part has only one line and includes three fields: type (required), scope (required) and subject (required).
    (1)type
    type is used to describe the category of commit. Only the following 7 identifiers are allowed.

    • feat：New features

    • ##fix：Fix bug

    • docs：Documentation

    • style： Format (changes that do not affect code operation)

    • #refactor: Refactoring (that is, code changes that are not new features or bug fixes)

    • test：Add test

    • ##build：

      Changes in the build process or auxiliary tools

      • (2 ) Scope
    scope is used to describe the scope of influence of commit, such as indicator templates, rules up and down, etc., which varies depending on the project.

    (3)subject
    subject is a short description of the commit purpose, no more than 50 characters.

      1. Begin with a verb, use the first person present tense, such as change, rather than changed or changes

      • 2. The first letter Lower case

      • 3. No period (.) at the end

      • 1.2 Body

    The Body part is for this commit Detailed description, can be divided into multiple lines.

      1. You need to briefly list various forward or reverse test scenarios. If the test passes, fill in the pass.

      • 2. Add modifier information

      • 2. Example

    2.1 feat example

    feat (rule online and offline, build, take effect, simulation take effect): Add rule online and offline function

    1. The main process of rule online and offline, the engine subscribes normally, and fldl is generated normally. pass

    2. When the rule goes online or offline, if a non-existent rule number is passed in, an exception will be prompted. pass


    Submitted by: xxx

    2.2 fix example

    fix (model module): Model test failed

    1. Import mar model, including derived fields. pass

    2. Import the mar model without derived fields. pass


    Submitted by: xxx

    Plug-in recommendation

    ideaYou can install plug-ins with code submission specifications.

    1. Install the plug-in

    ## 2.Select the plug-in to submit when submittingWhat are the usage specifications of Java Git Commit Message?

    What are the usage specifications of Java Git Commit Message?

    The above is the detailed content of What are the usage specifications of Java Git Commit Message?. For more information, please follow other related articles on the PHP Chinese website!

    Statement：
    This article is reproduced at:yisu.com. If there is any infringement, please contact admin@php.cn delete
    Previous article：How SpringBoot implements module log storageNext article：How SpringBoot implements module log storage

    Related articles

    See more