-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CONTRIBUTING
17 lines (12 loc) · 837 Bytes
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
SINCE GIT doesn't have an annotate file function to describe the purpose of every file, every file should have a header like so:
#Purpose: what this file does (".." means: should be obvious by file name)
#Needs: what it might ask from the system
#Publishes: what it gives to the system
#Donewhen: what state tells that this file or function`s purpose is completed
Follow Zen Code guidelines. See the Singularity project wiki (@github) for several coding philosophies and guidelines for architecting code.
NOTE: We don't have any real code yet, as this project is just in concept phase. I don't have the energy to write it myself and am actually still waiting on an Assembly model which I can trust.
Otherwise:
For code comments, user something like:
### FIXMEs (add more slashes (////) for C)
## WARNs
# regular INFO/comments