From 600e4eace60abb6fcc2b1484b0fcac563bd9cc5e Mon Sep 17 00:00:00 2001
From: Martin Sosic <sosic.martin@gmail.com>
Date: Tue, 22 Feb 2022 18:37:43 +0100
Subject: [PATCH] Added a bit on TODO/NOTE in code style guide.

---
 waspc/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/waspc/README.md b/waspc/README.md
index 40371b63e..2c9589b7e 100644
--- a/waspc/README.md
+++ b/waspc/README.md
@@ -317,8 +317,26 @@ We are documenting best practices related to Haskell in our [Haskell Handbook](h
 
 #### Comments
 
+#### Grammar
 When writing a comment, we prefer starting it with a capital letter.
 
 If it starts with a capital letter, it must end with a punctuation.
 
 If it doesn't start with a capital letter, it shouldn't end with a punctuation.
+
+#### TODO / NOTE
+
+When writing a TODO or NOTE, use all capital letters, like this:
+
+```hs
+-- TODO: Wash the car.
+
+-- NOTE: This piece of code is slow.
+```
+
+If you wish, you can add your name to TODO / NOTE. This is useful if you think there is a fair chance that reader of that TODO / NOTE might want to consult with its author.
+You can do it like this:
+
+```hs
+-- TODO(martin): Doesn't work on my machine in some unusual use cases.
+```