Mercurial > repos > public > sbplib_julia

diff WORKFLOW.md @ 1168:48cbcbc7a40b worklowdocs

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a few lines about special comments
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 07 Dec 2022 22:03:22 +0100
parents 6970bffad843
children
line wrap: on
line diff
--- a/WORKFLOW.md	Wed Dec 07 21:45:26 2022 +0100
+++ b/WORKFLOW.md	Wed Dec 07 22:03:22 2022 +0100
@@ -38,3 +38,9 @@
 * Review docstrings
 * Render Documenter and check docstrings in browser
 * Run full tests
+
+# Special comments
+The following special comments are used:
+* `# TODO: `: Something that should be done at some point.
+* `# TBD: `:  "To be determined", i.e a decision that has to be made.
+* `# REVIEW: `: A review comment. Should only exist on development branches.