You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,10 +47,9 @@ If you wish to contribute, please fork the repository and submit pull requests.
47
47
Also, assembly source code is formatted to the following specifications:
48
48
49
49
- Spaces only (no tabs)
50
-
- Labels start at column 1
51
-
- Opcodes start at column 21
52
-
- Operands start at column 31
53
-
- Comments start at column 51
50
+
- One space between opcode and operand, and operand and comments
51
+
52
+
This ensures a consistent experience and efficient representation in the repo.
54
53
55
54
Put [this file](https://github.com/nitros9project/nitros9/blob/main/scripts/pre-commit) in your .git/hooks folder to ensure that any source code you submit is automatically formatted.
56
55
@@ -69,13 +68,13 @@ Take time to write clearly about what a line of code is doing. Avoid repeating t
69
68
Instead of this:
70
69
71
70
```
72
-
clra clear A
71
+
clra clear A
73
72
```
74
73
75
74
do this:
76
75
77
76
```
78
-
clra set the path to standard input
77
+
clra set the path to standard input
79
78
```
80
79
81
80
## Write comments in lowercase and don't use punctuation
@@ -85,13 +84,13 @@ Comments may or may not be complete sentences; as such, dispense with the formal
85
84
Instead of this:
86
85
87
86
```
88
-
ldb #E$PNNF Prepare the "pathname not found" error.
87
+
ldb #E$PNNF Prepare the "pathname not found" error.
89
88
```
90
89
91
90
do this:
92
91
93
92
```
94
-
ldb #E$PNNF prepare the "pathname not found" error
93
+
ldb #E$PNNF prepare the "pathname not found" error
95
94
```
96
95
## Use full words
97
96
@@ -100,15 +99,15 @@ Avoid abbreviations. Spelling out words increases the readability of the comment
100
99
Instead of this:
101
100
102
101
```
103
-
pshs d,x,y,u push regs
104
-
leax ,u load path desc ptr in X
102
+
pshs d,x,y,u push regs
103
+
leax ,u load path desc ptr in X
105
104
```
106
105
107
106
do this:
108
107
109
108
```
110
-
pshs d,x,y,u save the registers on the stack
111
-
leax ,u load the path descriptor pointer in X
109
+
pshs d,x,y,u save the registers on the stack
110
+
leax ,u load the path descriptor pointer in X
112
111
```
113
112
114
113
## Ensure an empty line is at the end of a source file
@@ -119,12 +118,12 @@ the input do not abandon any important information on the last line.
0 commit comments