This is a living document. You are welcome to propose changes to this workflow by opening an issue.
Adopting a consistent style can improve code legibility through the choice of good naming conventions.
In addition, style checks will be run during CI to flag any severe non-conformance.
This allows code review discussions to focus on semantics and substance rather than pedantry.
Consistent whitespace usage, and not polluting line endings with trailing white space makes
git diffs considerably more legible.
This style guide is a living document and proposed changes may be adopted after discussing them and coming to a consensus.
.F90if preprocessing is required
testssubdirectory and have the same name as the module they are testing with the
test_prefix added E.g.,
By setting and following a convention for indentation and whitespace, code reviews and git-diffs can focus on the semantics of the proposed changes rather than style and formatting.
has_failedis preferred over
linspaceis preferred over
intentfor dummy arguments.
dimensionattribute to declare arrays because it is less verbose. Use this:
real, allocatable :: a(:), b(:,:)
real, dimension(:), allocatable :: a
real, dimension(:,:), allocatable :: b
dimensioncan be used as an exception if it makes the code less verbose.
optionalattribute is used to declare a dummy argument, it should follow the
Fortran allows certain block constructs or scopes to include the name of the program unit in the end statement.
The convention adopted herein is to include procedure names,
module names and
program names in the
unless the closing statement can reasonably be expected to be on the same screen or page, within about 25 lines.
Documentation strings should be provided for all public and protected entities and their arguments or parameters. This is currently accomplished using the FORD tool. For help writing FORD style documentation please see the FORD wiki. The following two sections are most relevant for contributing new code:
To write the "spec" (specification) for a new proposal, please place it in the
FORD "pages" directory at
To get help please see the "Writing Pages"
and "Writing Documentation" pages
on the FORD wiki.