summaryrefslogtreecommitdiff
path: root/topics/programming/coding-guidelines.gmi
diff options
context:
space:
mode:
authorPjotr Prins2023-12-03 09:47:38 -0600
committerPjotr Prins2023-12-03 09:47:38 -0600
commitbaeafc5ccc4a9893d22e6629db97720e3fa6d3ae (patch)
tree3701e477b4643893fbb33495ef64a758bba03de9 /topics/programming/coding-guidelines.gmi
parentaa3d310aa257f0ef0a8636272883c3c4e6855a1c (diff)
downloadgn-gemtext-baeafc5ccc4a9893d22e6629db97720e3fa6d3ae.tar.gz
Rename/move
Diffstat (limited to 'topics/programming/coding-guidelines.gmi')
-rw-r--r--topics/programming/coding-guidelines.gmi16
1 files changed, 16 insertions, 0 deletions
diff --git a/topics/programming/coding-guidelines.gmi b/topics/programming/coding-guidelines.gmi
new file mode 100644
index 0000000..8f83ba5
--- /dev/null
+++ b/topics/programming/coding-guidelines.gmi
@@ -0,0 +1,16 @@
+# Coding guidelines
+
+We aim to adhere to the following coding guidelines.
+
+=> /topics/use-exceptions-to-indicate-errors Exceptions, not None return values
+=> /topics/maybe-monad Maybe monad, not None values
+=> /topics/better-logging Log messages
+=> /topics/code-antipatterns Coding Anti-Patterns
+=> /topics/lisp/debugging Debugging lisp
+=> /topics/lisp/common-lisp-sly Common LISP: sly
+=> /topics/lisp/define-condition Common Lisp Condition Handling
+=> /topics/lisp/lisp4schemers Lisp For Schemers
+=> /topics/lisp/tips-and-tricks Defining a scheme sexp comment with a reader macro
+=> /topics/profiling_python_code Profiling Python code
+
+This document is an index of other documents describing coding guidelines. Add more here as you write/discover them.