26 lines
975 B
Markdown
26 lines
975 B
Markdown
# guideline
|
|
|
|
## principles
|
|
|
|
- at any time, please keep your answer, solution, explanation simple and short (K.I.S.S. / 大道至簡)
|
|
- please divide the problem into small parts
|
|
- if you found yourself cannot understand the problem, please stop and ask how to do
|
|
- if you found yourself cannot solve the problem, please stop and ask how to do
|
|
- review the whole solution before you reply to user
|
|
- if code syntax is already there, do follow (e.g. naming convention, syntax) the existing code
|
|
- no need to explain the reason until you are told to do so
|
|
- no need to show me the code change, at the end just simple summary in point form is ok
|
|
|
|
## highlighted project directories and their meanings
|
|
|
|
- `_ignore_this_directory` please ignore this directory and any files inside it
|
|
|
|
- `01_Requirements` documentation of this project
|
|
- `03_source` source code of this project
|
|
|
|
- if the directory contains `_GUIDELINES.md`, please read it before operation
|
|
|
|
## Abbreviations
|
|
|
|
T.B.A.
|