This commit is contained in:
Judah Caruso 2025-05-21 22:09:06 -06:00
parent 0230395bbc
commit d57256a367

View file

@ -18,11 +18,11 @@ create another commit moving the task from your 'IN
PROGRESS' section to the 'DONE' section; the commit PROGRESS' section to the 'DONE' section; the commit
message should only say 'finish [id]'. message should only say 'finish [id]'.
// Starting commit // Final commit
commit SOME HASH commit SOME HASH
Author: Your Name <your@email> Author: Your Name <your@email>
start 034 finish 034
// Intermediate commits // Intermediate commits
commit SOME HASH commit SOME HASH
@ -30,11 +30,11 @@ message should only say 'finish [id]'.
Blah blah blah Blah blah blah
// Final commit // Starting commit
commit SOME HASH commit SOME HASH
Author: Your Name <your@email> Author: Your Name <your@email>
finish 034 start 034
Writing Code Writing Code
@ -48,14 +48,14 @@ Things I actually care about:
- Don't be clever. Write code that does the job; - Don't be clever. Write code that does the job;
nothing more, nothing less. nothing more, nothing less.
- Comment your code. I very much disagree with the - Comment your code. I very much disagree with the
premise that code is self-documenting. Take a step premise that code is self-documenting. Take a step
back and write a comment (with your name) that back and write a comment (with your name) that
explains *why* you're doing *what* you're doing. explains *why* you're doing *what* you're doing.
Please try to stick to this format: Please try to stick to this format:
@note, @todo, @temp, @allocates, @leak @note, @todo, @temp, @allocates, @leak
- Descriptive names. In general, it's fine to use short - Descriptive names. In general, it's fine to use short
names for local variables. However, you should names for local variables. However, you should
almost always opt for longer, more descriptive names almost always opt for longer, more descriptive names