Skip to content

Commit 225a734

Browse files
add data flow and workflow to dev intro
1 parent ac6b540 commit 225a734

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/development/Guide_CLIMADA_Development.ipynb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
" - Bring it to a developers meeting - people may be able to help/advise and are always interested in hearing about new projects. You can also find reviewers!\n",
4242
" - Also, keep talking! Your plans _will_ change :)\n",
4343
"\n",
44+
"### Formulate the feature's data flow and workflow\n",
45+
"\n",
46+
"To optimize implementation and usefulness of the new feature, first conceptualize its data flow and workflow. It makes sense to discuss these with a CLIMADA core developer before starting to work on the feature's implementation.\n",
47+
"- **Data flow**: Outline of how data moves through the system — where it is created or input, how it is processed, and if and where it is stored. This helps to improve the computational efficiency and to identify potential bottlenecks. \n",
48+
"- **Workflow**: Plan about where and how the user and other CLIMADA components can interact with the new feature. This ensures that the new feature couples seamlessly to the existing code base of CLIMADA and that the new feaute is easily and clearly accessible to users.\n",
49+
"\n",
4450
"### Planning the work\n",
4551
"\n",
4652
"- Does the project go in its own repository and import CLIMADA, or does it extend the main CLIMADA repository. The way this is done is slowly changing, so definitely discuss it with the group.\n",

0 commit comments

Comments
 (0)