Skip to content

Style guide (see #3) #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Dec 31, 2019
Merged
Prev Previous commit
Next Next commit
style: consistently use asterisks for bullets
zbeekman committed Dec 29, 2019

Verified

This commit was signed with the committer’s verified signature. The key has expired.
zbeekman Izaak "Zaak" Beekman
commit 7401a198219a6cda1299670ad9bc913595a83b20
9 changes: 5 additions & 4 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -11,14 +11,15 @@

## File naming conventions

- Source files should contain at most one `program`, `module`, or `submodule`.
- The filename should match the program or module name and have the file extension `.f90` or `.F90` if preprocessing is required.
- If the interface and implementation is split using submodules the implementation submodule file should have the same name as the
* Source files should contain at most one `program`, `module`, or `submodule`.
* The filename should match the program or module name and have the file extension `.f90` or `.F90` if preprocessing is required.
* If the interface and implementation is split using submodules the implementation submodule file should have the same name as the
interface (parent) module but end in `_implementation`.
E.g., `string_class.f90` and `string_class_implementation.f90`
- Tests should be added in the `tests` subdirectory and have the same name as the module they are testing with the `test_` prefix
* Tests should be added in the `tests` subdirectory and have the same name as the module they are testing with the `test_` prefix
added.
E.g., `string_class.f90` and `tests/test_string_class.f90`
* There should only ever be one `program` and `module` statement per file.

## Indentation & whitespace