annotate WORKFLOW.md @ 1161:74c09b5f63eb worklowdocs

Start writing a file discribing the development workflow
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 29 Nov 2022 22:34:16 +0100
parents
children 32b4d324fd98
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1161
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # Branch model
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 # Review
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 ## Checklist for review
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 * Push and pull new changes
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 * Search and check TODOs
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 * Search and check TBDs
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 * Search and check REVIEWs
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10 * Review code
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 * Review tests
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 * Review Docstrings
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 * Render Documenter and check docstrings in browser
74c09b5f63eb Start writing a file discribing the development workflow
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 * Run full tests