Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.46 KB

NexT logo

MirrorTree Wiki

Once upon a time, there was a Mirror Tree.

About This Repository

File Structure

Documentation Norm

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.

Git Norm

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 as feat, fix, docs, style, refactor, test, chore, etc.
  • <scoop> (optional) : The scope of the commit, such as algorithm, communication, archive, etc.
  • <subject>: A brief summary of the commit. It should be in the imperative mood without dot (.) at the end of a line.
  • <body> (optional) : A detailed description of the commit.
  • <footer> (optional) : A footer for the commit, such as BREAKING CHANGE, ISSUES CLOSED, etc.

Note

Although pull requests are different from commits, you may follow the same format when writing a pull request.

License

CC BY-NC-SA 4.0