当前位置:网站首页>Git submission specification

Git submission specification

2020-11-06 23:23:59 read

Reference documents   Document 2

Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

type

  • feat: newly added / Modify the function (feature).
  • fix: Mend bug (bug fix).
  • docs: file (documentation).
  • style: Format ( Changes that do not affect the running of the code white-space, formatting, missing semi colons, etc).
  • refactor: Refactoring ( It's not a new feature , It's not a fix bug Code changes for ).
  • perf: Improving performance (A code change that improves performance).
  • test: Add tests (when adding missing tests).
  • chore: Changes in construction procedures or AIDS (maintain).
  • revert: To withdraw a reply to a previous commit for example :revert: type(scope): subject ( Reply version :xxxx).

Example 1 :

① docs

docs:  Add a note 
docs:  Fixed type annotation 

 Let  IDE  The correct category can be read 
docs:  Remove expired annotations 

issue #1229

② style

style: message  Page , Yes  Component  do  Beautifier

 Classics  IE  Browser test found  Component  It's still carrying  ES6  Grammar ,
 But at the moment  Component  The code is compressed into one line ,
 For the convenience of modifying the program in the future , So first, do... For all compressed code  Beautifier

 Adjust the project :
1.  Do... For all compressed code  Beautifier
2.  Remove annotated code , The code to be annotated should be pre compressed code , But after testing, it was found that the annotated code was old  Code, So remove .

issue #1219
issue #1028
style:  Uniform line breaks  CRLF to LF

 Uniform line breaks 
style:  Adjust  HTML  indent 

issue #964

③ chore

chore:  to update  testing  The environment 

 to update  ci-phpunit-test  Kit  0.16 => 0.17

for Request GET  With parameter function .
chore: Adjust the unit test environment 

 Adjust the project :
1. MX/Modules
 Make it customized  Testing  The logic of removing , Otherwise, the file cannot be accessed correctly in the test environment .
2.  Join in  tests/unit  And  tests/integration  Catalog , And move the test file to the appropriate location .
3. AdminTestCase.php, Inherit  TestCase, Implement login logic 、setUp  And  tearDown, For other test case inheritance use .
4. Bootstrap.php, introduce  AdminTestCase.php  Test case inheritance .
5. Login.php, Because there can't be  header  Settings for , Change system login logic , Use... In the test environment  redirect  Address transfer .
6. phpunit.xml, Remove the rigorous announcement coverage mode , Avoid causing the test to fail ( If you need to know what categories or logic your test case covers , It can be opened by itself ).

##  Note : unit  And  integration  Catalog 
 They are 「 Unit test directory 」 And 「 Integrate test catalog 」, The unit test catalog is responsible for testing  Api  And  Model, The integrated test catalog is responsible for testing  Controller.

issue #709

④ perf

perf:  List of evaluation forms , Optimize the speed of getting reviewers 

 The logic of getting the reviewers will cause the page to load slowly ( The development machine is about  52  second ), So optimize .

 How to adjust :
 The original code loops into each form  DB  Get the information of the appraisee .
 Change to 
 Enter  DB  Get all the information of the appraisees at one time , Back to  PHP  Distribution data .

 It turns out :
 Developer load page time   52  second  => 5 second 

issue #1272

⑤ refacotr

refactor:  Daily notification letter , Refactoring the program structure 

 Consider that you may need to send a variety of information to users in the future ,
 So refactoring the program structure , It's more convenient to expand functions in the future .

 Adjust the content :
1. Send_today_notify_mail:
  -  To get 「 System notification 」 Logic moved to  System_notify_handler.php
  -  To get 「 On site messages 」 Logic moved to  Message_handler.php
  -  introduce  Pipeline, Put the logic of getting all kinds of system information into  Pipeline.
  -  Through  Pipeline  Get the contents of the daily notification letter , And build letters  HTML
2. Daily_email  Interface :
  -  Define   Daily mail processor  Xxx_handler  Methods 
  -  After that, we need to expand new functions , It must be in accordance with  Daily_email  The definition of the interface , Implementation method .
3. message.php、system_notify.php:
  -  Will 「 System notification 」 And 「 On site messages 」 Of  Email  Page independent .

issue #1308

⑥ feat

feat:  Form statistics , Show more project name fields 

 Adjust to the needs :
1.  Add more information to the list 「 Project name 」 Hurdles , In order to facilitate the subsequent export data processing .

 Adjust the project :
1. Assessment_form.php, When exporting form statistics , Add training program name field .
2. customize.php, Form statistics query , Show more training program name fields .
3. Complex_assessment_form_api.phpComplex_assessment_form_model_api.php-  When getting form statistics , Get more project names .

issue #1200

⑦ fix

fix:  Opinion response , The letter can't see the picture problem 

 The problem is :
1.  Customer response : No pictures can be seen in the letters of opinion response .

 reason :
1.  At present, the code will require you to log in before you can view the files uploaded by users ,
    The problem is that you can't see the picture on the letter .

 Adjust the project :
1. File.php, After discussion , Open the file that the opinion response page Uploads , You can view it without logging in / Download .

issue #1229

Example 2 :

① Document adjustment

docs: correct spelling of CHANGELOG

② Include scope

feat(lang): add polish language

③ by fix Written submission instructions , contain ( Optional ) issue Number

fix: correct minor typos in code

see the issue for details on the typos fixed

closes issue #12

④ Includes optional  !  Characters to alert attention to the submission instructions for disruptive changes

chore!: drop Node 6 from testing matrix

BREAKING CHANGE: dropping Node 6 which hits end of life in April

 

版权声明
本文为[read]所创,转载请带上原文链接,感谢