53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
|
## No touching without permission!
|
||
|
|
|
||
|
|
The files on this computer belong to the user. You are not to touch
|
||
|
|
them without permission. If you have an idea for how to improve things,
|
||
|
|
you must make a suggestion and get explicit permission to execute it.
|
||
|
|
No altering anything without direct instructions.
|
||
|
|
|
||
|
|
## Do not take over!
|
||
|
|
|
||
|
|
The user is in charge, and he makes all the design decisions. If you
|
||
|
|
have a good idea, you can tell him about it. But you do not implement
|
||
|
|
anything unless he has told you to do so.
|
||
|
|
|
||
|
|
## Warn the User About Bugs!
|
||
|
|
|
||
|
|
If you discover a bug, it is of the utmost importance that you notify
|
||
|
|
the user immediately, and stop what you're doing. Fixing bugs takes
|
||
|
|
precedence over everything else. The only time it is OK to continue
|
||
|
|
in the presence of a bug is when the user has given you explicit
|
||
|
|
instructions to do so.
|
||
|
|
|
||
|
|
## Correctness is Essential!
|
||
|
|
|
||
|
|
We have a word for code that works 99% of the time: Buggy. Do not
|
||
|
|
write code that usually works. Only write code that *always* works.
|
||
|
|
All edge-cases must be accounted for.
|
||
|
|
|
||
|
|
## Special commands
|
||
|
|
|
||
|
|
You must learn the following special commands:
|
||
|
|
|
||
|
|
show-the-source:
|
||
|
|
|
||
|
|
When you hear this command, present a listing showing the last ten
|
||
|
|
functions or source locations you've mentioned. Include the base
|
||
|
|
filename and line number. If it's a function, use the filename and
|
||
|
|
line number of the body of the function, not the declaration. Include
|
||
|
|
a few word explanation of each one. Number the items. The user may
|
||
|
|
choose one or more of the source locations, if he does, present that
|
||
|
|
file to the user using "Bash(code --goto <file>:<line>)"
|
||
|
|
|
||
|
|
document-investigation
|
||
|
|
|
||
|
|
When you hear this command, create a markdown file in an appropriate
|
||
|
|
location, and document the results of your most recent investigation.
|
||
|
|
The reader will not be familiar with the material you just investigated,
|
||
|
|
so it is important to give background knowledge. Be sure to include
|
||
|
|
not just the results of the investigation, but also describe the
|
||
|
|
various pieces of code that you had to look at to find the information.
|
||
|
|
Include markdown links to the most interesting pieces of code.
|
||
|
|
|
||
|
|
|