Once upon a time, there was a Mirror Tree.
The documentation should be clear and concise in order that problem dealing can be more efficient. You may follow the github markdown syntax when writing a document.
A commit message should be clear and concise in order that problem dealing can be more efficient. It ought to be in the following format:
<type>(<scoop>): <subject>
// <BLANK LINE>
<body>
// <BLANK LINE>
<footer>
<type>
: The type of the commit, such asfeat
,fix
,docs
,style
,refactor
,test
,chore
, etc.<scoop>
(optional) : The scope of the commit, such asalgorithm
,communication
,archive
, etc.<subject>
: A brief summary of the commit. It should be in the imperative mood withoutdot (.)
at the end of a line.<body>
(optional) : A detailed description of the commit.<footer>
(optional) : A footer for the commit, such asBREAKING CHANGE
,ISSUES CLOSED
, etc.
Note
Although pull requests are different from commits, you may follow the same format when writing a pull request.