├── LICENSE ├── README.md └── Recommendations ├── R10_CInteroperability.md ├── R1_ModernStandardCompliance.md ├── R2_ProceduresInModules.md ├── R3_RestrictDataVisibility.md ├── R4_ImproveDummyArguments.md ├── R5_ImproveDataTypes.md ├── R6_AvoidLegacyControlFlow.md ├── R7_EnhanceCodeSemantics.md ├── R8_CodeConventions.md └── R9_ModernDevelopmentPractices.md /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Top 10 Recommendations for Fortran Modernization 2 | 3 | Modernizing Fortran codebases is a crucial step toward improving code quality 4 | and ensuring maintainability. It helps developers uncover hidden bugs and 5 | reduces the risk of introducing new errors during development. Additionally, 6 | these efforts support modern compilers and tools in generating optimized code 7 | and identifying potential issues early. Ultimately, modernization boosts 8 | developer productivity and enhances code robustness. 9 | 10 | ## Context and motivation 11 | 12 | This project is inspired by the [OWASP](https://owasp.org/) community-led 13 | initiative, which regularly publishes the most relevant Top 10 Secure Coding 14 | Recommendations. These are widely adopted by the industry to help developers 15 | avoid common security vulnerabilities. The OWASP initiative thrives on 16 | collaboration and knowledge sharing through platforms like their [GitHub 17 | repository](https://github.com/OWASP/Top10). 18 | 19 | Beyond OWASP, various open catalogs provide comprehensive collections of checks 20 | (rules) to help ensure secure coding practices. Each check describes specific 21 | scenarios and necessary actions, offering extensive documentation, example 22 | codes, automated code analysis tools, and references to other resources. 23 | Notable examples include [SEI CERT 24 | C](https://wiki.sei.cmu.edu/confluence/display/c) and 25 | [CWE](https://cwe.mitre.org/). 26 | 27 | Building on these foundations, this project aims to start a similar 28 | community-driven initiative focused on modern Fortran software development. 29 | Leveraging the existing [Open Catalog of Code Guidelines for Correctness, 30 | Modernization, Security, Portability and 31 | Optimization](https://github.com/codee-com/open-catalog/), we seek to establish 32 | a dedicated set of Top 10 Recommendations and related checks to address the 33 | specific challenges of Fortran Modernization. 34 | 35 | Modernizing Fortran code encompasses updating and maintaining legacy Fortran 36 | codes (e.g., F77, F90) with extensive development histories. It also involves 37 | refactoring existing Fortran codes to leverage the features of the latest 38 | Fortran standards (e.g., transitioning from F90 to F23). 39 | 40 | ## Methodology 41 | 42 | To develop the Top 10 Recommendations for Fortran Modernization, we adopted a 43 | comprehensive and community-focused approach. First, we conducted an extensive 44 | review of existing resources on the topic to identify an initial draft of the 45 | most recurrent recommendations. These were later discussed with the Fortran 46 | development community to collect insights and feedback (e.g., in Fortran 47 | Discourse 48 | [[12](https://fortran-lang.discourse.group/t/our-initiative-to-publish-the-fortran-lang-top-10-recommendation-for-fortran-modernization-is-it-really-new-or-even-feasible/7774)]), 49 | which were crucial for shaping the final proposal. 50 | 51 | The presented Top 10 Recommendations are prioritized to guide developers 52 | through a progression of modernization efforts. Each recommendation is detailed 53 | with specific checks that describe actionable steps, including examples of 54 | before and after code snippets, the rationale behind the changes, and links to 55 | further reading. 56 | 57 | To ensure the recommendations remain relevant and comprehensive, we plan to 58 | continuously review community input and update the guidelines as the Fortran 59 | standards evolve and new best practices emerge. 60 | 61 | ## Top 10 Recommendations 62 | 63 | 1. [Strict compliance with modern Fortran 64 | standards](Recommendations/R1_ModernStandardCompliance.md). 65 | 66 | 2. [Declare procedures in modules](Recommendations/R2_ProceduresInModules.md). 67 | 68 | 3. [Restrict data visibility with 69 | modules](Recommendations/R3_RestrictDataVisibility.md). 70 | 71 | 4. [Improve dummy arguments 72 | semantics](Recommendations/R4_ImproveDummyArguments.md). 73 | 74 | 5. [Improve data type consistency and 75 | management](Recommendations/R5_ImproveDataTypes.md). 76 | 77 | 6. [Avoid legacy control-flow 78 | constructs](Recommendations/R6_AvoidLegacyControlFlow.md). 79 | 80 | 7. [Enhance source code semantics](Recommendations/R7_EnhanceCodeSemantics.md). 81 | 82 | 8. [Adhere to code conventions](Recommendations/R8_CodeConventions.md). 83 | 84 | 9. [Adopt modern development 85 | practices](Recommendations/R9_ModernDevelopmentPractices.md). 86 | 87 | 10. [Proper C/C++ interoperability](Recommendations/R10_CInteroperability.md). 88 | 89 | ## Contributing 90 | 91 | We welcome and encourage contributions to the Top 10 Recommendations! Here's 92 | how you can get involved: 93 | 94 | 1. **Join the discussion:** 95 | 96 | Got ideas, questions, or suggestions? Head over to our [GitHub 97 | Discussions](https://github.com/codee-com/fortran-modernization/discussions). 98 | It's the perfect place for open-ended conversations and brainstorming! 99 | 100 | 2. **Report issues:** 101 | 102 | Found inacuracies, unclear explanations, or other problems? Please open an 103 | [**Issue**](https://github.com/codee-com/fortran-modernization/issues). 104 | Detailed reports help us quickly improve the quality of the project! 105 | 106 | 3. **Submit pull requests:** 107 | 108 | Interested in solving any issues? Feel free to fork the repository, make 109 | your changes, and submit a [Pull 110 | Request](https://github.com/codee-com/fortran-modernization/pulls). We'd 111 | love to see your contributions! 112 | 113 | ## References 114 | 115 | - [1] Fortran Community. "Fortran Best Practices". Accessed: Jun. 06, 2024. 116 | [Online] Available: https://fortran-lang.org/en/learn/best_practices/ 117 | 118 | - [2] Fortran Wiki Contributors. "Modernizing Old Fortran". Accessed: Jun. 06, 119 | 2024. [Online] Available: 120 | https://fortranwiki.org/fortran/show/Modernizing+Old+Fortran 121 | 122 | - [3] Fortran Discourse Community. "Fortran Discourse". Accessed: Jun. 06, 123 | 2024. [Online] Available: https://fortran-lang.discourse.group 124 | 125 | - [4] Reinhold Bader. "Fortran code modernization". Accessed: Jun. 06, 2024. 126 | [Online] Available: 127 | https://www.ugent.be/hpc/en/training/2018/modern_fortran_materials/modernfortran2018.pdf 128 | 129 | - [5] The Numerical Algorithms Group. "Fortran Modernisation Workshop". 130 | Accessed: Jun. 06, 2024. [Online] Available: 131 | https://blog.rwth-aachen.de/hpc_import_20210107/attachments/39157901/39420371.pdf 132 | 133 | - [6] The Carpentries. "Best Practices in Modern Fortran". Accessed: Jun. 06, 134 | 2024. [Online] Available: 135 | https://wvuhpc.github.io/Modern-Fortran/11-Best-Practices/index.html 136 | 137 | - [7] Norman S. Clerman, Walter Spector. "Modern Fortran: Style and Usage". 1st 138 | Edition, 2011. 139 | 140 | - [8] Michael Metcalf, John Reid, Malcolm Cohen, Reinhold Bader. "Modern 141 | Fortran Explained". 6th Edition, 2023. 142 | 143 | - [9] Fortran Users of NERSC (FUN). "FUN Training July 2023: Modern Fortran 144 | Basics". Accessed: Jun. 06, 2024. [Online] Available: 145 | https://www.nersc.gov/users/training/past-training-events/2023/fun-training-july-2023-modern-fortran-basics/ 146 | 147 | - [10] Jack Carlson, Olaf David. "Fortran 90/95 Coding Conventions - Fortran 148 | Features that are obsolescent and/or discouraged". Accessed: Jun. 06, 2024. 149 | [Online] Available: 150 | https://alm.engr.colostate.edu/cb/wiki/16983#section-Fortran+Features+that+are+obsolescent+and_2For+discouraged 151 | 152 | - [11] GitHub Collaborators. "Best practices and styles guidelines of Fortran 153 | FOSS Programmers". Accessed: Jun. 06, 2024. [Online] Available: 154 | https://github.com/Fortran-FOSS-Programmers/Best_Practices 155 | 156 | - [12] Fortran Discourse Community. "Our initiative to publish the 157 | 'Fortran-lang Top 10 Recommendation for Fortran modernization', is it really 158 | new or even feasible?". Accessed: Jun. 06, 2024. [Online] Available: 159 | https://fortran-lang.discourse.group/t/our-initiative-to-publish-the-fortran-lang-top-10-recommendation-for-fortran-modernization-is-it-really-new-or-even-feasible/7774 160 | 161 | - [13] GitHub Collaborators. "Open Catalog of Code Guidelines for 162 | Correctness, Modernization, Security, Portability, and Optimization". Accessed: Feb. 18, 163 | 2025. [Online] Available: https://github.com/codee-com/open-catalog 164 | -------------------------------------------------------------------------------- /Recommendations/R10_CInteroperability.md: -------------------------------------------------------------------------------- 1 | # 10. Proper C/C++ interoperability 2 | 3 | ## Overview 4 | 5 | Ensure seamless interoperability between Fortran and C/C++ to allow Fortran 6 | programs to effectively interact with a wide range of systems and libraries 7 | written in other languages (e.g., high-performance environments). 8 | 9 | ## Checks 10 | 11 | - _Planned: Encapsulate calls to external programming models in specific 12 | procedures or modules._ 13 | -------------------------------------------------------------------------------- /Recommendations/R1_ModernStandardCompliance.md: -------------------------------------------------------------------------------- 1 | # 1. Strict compliance with modern Fortran standards 2 | 3 | ## Overview 4 | 5 | Remove legacy features deleted from recent Fortran standards, as they might not 6 | be supported by recent compilers, and avoid compiler-specific extensions, 7 | ensuring that the code remains compatible across various development 8 | environments. 9 | 10 | ## Checks 11 | 12 | - [PWR075](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR075): 13 | Avoid using GNU Fortran extensions. 14 | 15 | - _Planned: Tune compiler flags to mark features removed from recent Fortran 16 | standards._ 17 | 18 | - _Planned: Tune compiler flags to mark compiler-specific constructs._ 19 | -------------------------------------------------------------------------------- /Recommendations/R2_ProceduresInModules.md: -------------------------------------------------------------------------------- 1 | # 2. Declare procedures in modules 2 | 3 | ## Overview 4 | 5 | Declare related procedures within an importable module to enhance code 6 | modularity, reusability, and readability. This practice also helps avoid 7 | runtime errors related to implicit interfaces. Separate the definition of 8 | procedures into modules and their implementation into submodules, leveraging 9 | incremental compilation to reduce build times. 10 | 11 | ## Checks 12 | 13 | - [PWR068](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR068): 14 | Encapsulate procedures within modules to avoid the risks of calling implicit 15 | interfaces. 16 | 17 | - _Planned: Consider moving the module's procedure implementations into a 18 | separate submodule._ 19 | -------------------------------------------------------------------------------- /Recommendations/R3_RestrictDataVisibility.md: -------------------------------------------------------------------------------- 1 | # 3. Restrict data visibility with modules 2 | 3 | ## Overview 4 | 5 | Encapsulate globally accessible data, such as common blocks, within modules. 6 | This approach allows for controlled access interfaces, improving code 7 | readability and minimizing side effects from global data storage. 8 | 9 | ## Checks 10 | 11 | - [PWR073](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR073): 12 | Transform common block into a module for better data encapsulation. 13 | 14 | - [PWR069](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR069): 15 | Use the keyword only to explicitly state what to import from a module. 16 | 17 | - _Planned: Minimize mutable module variables by passing data as procedure 18 | arguments._ 19 | 20 | - _Planned: Privatize mutable module variables and add procedures for more 21 | controlled access._ 22 | -------------------------------------------------------------------------------- /Recommendations/R4_ImproveDummyArguments.md: -------------------------------------------------------------------------------- 1 | # 4. Improve dummy arguments semantics 2 | 3 | ## Overview 4 | 5 | Enhance the definitions of dummy arguments to make the behavior of procedures 6 | more predictable and transparent, helping avoid common issues related to 7 | incorrect assumptions about data type, flow, or structure. 8 | 9 | ## Checks 10 | 11 | - [PWR008](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR008): 12 | Declare the intent for each procedure argument. 13 | 14 | - [PWR070](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR070): 15 | Declare array dummy arguments as assumed-shape arrays. 16 | 17 | - _Planned: Add a contiguous attribute to applicable assumed-shape arrays._ 18 | -------------------------------------------------------------------------------- /Recommendations/R5_ImproveDataTypes.md: -------------------------------------------------------------------------------- 1 | # 5. Improve data type consistency and management 2 | 3 | ## Overview 4 | 5 | Ensure the consistency of data types by avoiding implicit typing and 6 | standardizing the code on a fixed set of real kinds, improving readability and 7 | portability across different development environments. Use derived data types 8 | to represent complex multi-field structures. Leverage pointers and allocatable 9 | arrays for safer memory handling. 10 | 11 | ## Checks 12 | 13 | - [PWR007](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR007): 14 | Disable implicit declaration of variables and procedures. 15 | 16 | - [PWR071](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR071): 17 | Prefer real(kind=kind_value) for declaring consistent floating types. 18 | 19 | - _Planned: Prefer derived types over constructs such as structure or record to 20 | represent complex multi-field entities_. 21 | 22 | - _Planned: Replace equivalence statements by pointers or the transfer 23 | intrinsic as needed._ 24 | 25 | - _Planned: Consider replacing fixed-size arrays with allocatables._ 26 | -------------------------------------------------------------------------------- /Recommendations/R6_AvoidLegacyControlFlow.md: -------------------------------------------------------------------------------- 1 | # 6. Avoid legacy control-flow constructs 2 | 3 | ## Overview 4 | 5 | Replace outdated and error-prone control-flow constructs with more robust and 6 | maintainable language features from recent standards, improving code 7 | maintainability and reducing the likelihood of bugs. 8 | 9 | ## Checks 10 | 11 | - [PWR063](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR063): 12 | Avoid using legacy Fortran constructs. 13 | 14 | - _Planned: Use case or if-then-else constructs instead of go to statements for 15 | conditional flow._ 16 | 17 | - _Planned: Use do, cycle, and exit constructs instead of go to statements for 18 | loops._ 19 | 20 | - _Planned: Replace arithmetic if statements with block if constructs._ 21 | 22 | - _Planned: Convert numbered do loops to modern do loops._ 23 | 24 | - _Planned: End all loops with an end do statement._ 25 | 26 | - _Planned: Use only integer control variables in do loops._ 27 | 28 | - _Planned: Replace forall statements with do-concurrent constructs._ 29 | 30 | - _Planned: Avoid alternate return statements._ 31 | 32 | - _Planned: Replace compiler-dependant short-circuit logic with nested 33 | conditionals._ 34 | -------------------------------------------------------------------------------- /Recommendations/R7_EnhanceCodeSemantics.md: -------------------------------------------------------------------------------- 1 | # 7. Enhance source code semantics 2 | 3 | ## Overview 4 | 5 | Leverage elements from recent Fortran standards to further improve the clarity 6 | and intent of code statements beyond previous recommendations. 7 | 8 | ## Checks 9 | 10 | - [PWR003](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR003): 11 | Explicitly declare pure functions. 12 | 13 | - [PWR072](https://github.com/codee-com/open-catalog/blob/main/Checks/PWR072): 14 | Explicitly declare the 'save' attribute or split the variable initialization 15 | to prevent unintended behavior. 16 | 17 | - _Planned: Prefer variable initializations at declaration instead of data or 18 | block data statements._ 19 | 20 | - _Planned: Add an explicit parameter attribute to constant variables._ 21 | 22 | - _Planned: Explicitly declare elemental functions._ 23 | -------------------------------------------------------------------------------- /Recommendations/R8_CodeConventions.md: -------------------------------------------------------------------------------- 1 | # 8. Adhere to code conventions 2 | 3 | ## Overview 4 | 5 | Establish and adhere to a consistent coding standard, such as variable naming 6 | rules of free-form format, to promote readability and ease collaboration among 7 | developers. 8 | 9 | ## Checks 10 | 11 | - _Planned: Tune compiler flags to mark fixed-form Fortran code._ 12 | -------------------------------------------------------------------------------- /Recommendations/R9_ModernDevelopmentPractices.md: -------------------------------------------------------------------------------- 1 | # 9. Adopt modern development practices 2 | 3 | ## Overview 4 | 5 | Integrate modern development practices, such as automated testing, version 6 | control, or dependency managers, to enhance the quality, maintainability, 7 | collaboration, and distribution of Fortran software. 8 | 9 | ## Checks 10 | 11 | _Work in progress_ 12 | --------------------------------------------------------------------------------