bruno/remotely-save
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add code design

Browse Source
This commit is contained in:
fyears 2021-10-24 13:12:45 +08:00
parent 21f8789b27
commit 29145604be
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/code_design.md Normal file
View File

@ -0,0 +1,13 @@
# Code Design
## Code Organization
1. Every function except `main.ts` should be pure. Pass any stateful information in parameters.
2. `misc.ts` should not depend on any other written code.
3. Each storage code should not depend on `sync.ts`.
## File and Folder Representation
While writing sync codes, folders are always represented by a string ending with `/`.