You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/sphinx/source/developer_guide2/git_repository.inc
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
.. _git_repository:
2
2
3
+
**************
3
4
Git repository
4
5
**************
5
6
@@ -161,7 +162,7 @@ Do-s
161
162
* Comment your code as much as possible and in English.
162
163
* Use short but self-explanatory variable names (e.g., model_input and reference_input instead of xm and xr).
163
164
* Consider a modular/functional programming style. This often makes code easier to read and deletes intermediate variables immediately. If possible, separate diagnostic calculations from plotting routines.
164
-
* Consider reusing or extending existing code. General-purpose code can be found in diag_scripts/lib/ and in plot_scripts/.
165
+
* Consider reusing or extending existing code. General-purpose code can be found in esmvaltool/diag_scripts/shared/.
165
166
* Comment all switches and parameters including a list of all possible settings/options in the header section of your code (see also Section :ref:`std_diag`).
166
167
* Use templates for recipes (Section :ref:`std_recipe`) and diagnostics (Section :ref:`std_diag`) to help with proper documentation.
167
168
* Keep your *FEATURE BRANCH* regularly synchronized with the *DEVELOPMENT BRANCH* (git merge).
@@ -174,5 +175,5 @@ Don't-s
174
175
* Do not develop without proper version control (see do-s above).
175
176
* Avoid large (memory, disk space) intermediate results. Delete intermediate files/variables or see modular/functional programming style.
176
177
* Do not use hard-coded pathnames or filenames.
177
-
* Do not mix developments / modifications of the ESMValTool framework and developments / modifications of diagnotics in the same *FEATURE BRANCH*.
178
+
* Do not mix developments / modifications of the ESMValTool framework and developments / modifications of diagnostics in the same *FEATURE BRANCH*.
0 commit comments