diff --git a/HACKING b/HACKING new file mode 100644 index 0000000000..c2c403bd1d --- /dev/null +++ b/HACKING @@ -0,0 +1,14 @@ +Test Data/Configuration +----------------------- +- Assume nothing about existing test data +- Tests should be self contained (provide their own data) +- Clean up test data at the completion of each test +- Use configuration files for values that will vary by environment + +General +------- +- Put two newlines between top-level code (funcs, classes, etc) +- Put one newline between methods in classes and anywhere else +- Do not write "except:", use "except Exception:" at the very least +- Include your name with TODOs as in "#TODO(termie)" +- Do not name anything the same name as a built-in or reserved word \ No newline at end of file