38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# guideline
|
|
|
|
## principles
|
|
|
|
- at any time, please keep your answer, solution, explaination simple and short (K.I.S.S. or 大道至簡)
|
|
- please divide the problem into small parts
|
|
- if you found youself cannot understand the problem, please stop and ask how to do
|
|
- if you found youself cannot solve the problem, plesae 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
|
|
|
|
- `001_documentation` documentation of this project
|
|
- `002_source` source code of this project
|
|
- `002_source/cms` home of Context management system of this project
|
|
- use singular form for `src/components/dashboard` (e.g. `src/components/dashboard/student`)
|
|
- use plural form for `src/app/dashboard` (e.g. `src/app/dashboard/students`)
|
|
- `002_source/ionic_mobile` home of mobile client of this project
|
|
- `002_source/pocketbase` home of pocketbase home directory this project
|
|
- `003_test` e2e test of this project (not yet implemented)
|
|
- `004_marketing` marketing page of this project (not yet implemented)
|
|
- `005_references` opensource refence of this project
|
|
- `006_lab` my test (POC) of this project
|
|
- `README.md` Readme of this project
|
|
- `TODO.md` todo list of this project
|
|
- `001_documentation/Requirements/REQ0019/index.md` describes updated system architecture
|
|
|
|
- if the directory contains `_GUIDELINES.md`, please read it before operation
|
|
|
|
## Abbreviations
|
|
|
|
T.B.A.
|