ecmwf-ifs / ifs-arpege-coding-standards

Official coding standard for IFS / Arpège
Apache License 2.0
3 stars 4 forks source link

Improvements of examples and additional "Howto" guides #1

Open mlange05 opened 1 year ago

mlange05 commented 1 year ago

Note: This long-standing issue is meant to facilitate an ongoing discussion about ways in which to improve aspects of this document.

While one of the key points of this document is to enshrine the underlying rules that may be used for automated code checking and guided refactoring, it is important to make this document not only prohibitive, but also provide guidance and examples on how to write "good code". These need not be tied to individual rules, but suggestions might include overarching changes, like refactoring of the document, or addition of specific "Howto guides". The intention for this issue is the discuss such suggestions before embarking on large-scale restructuring or implementation efforts.