fortitude 0.3.0

A Fortran linter, written in Rust and installable with Python
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

<!-- omit in toc -->
# Contributing to Fortitude

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the [Table of
Contents](#table-of-contents) for different ways to help and details about how this
project handles them. Please make sure to read the relevant section before making your
contribution. It will make it a lot easier for the maintainers and smooth out the
experience for all involved. We look forward to your contributions!

> And if you like the project, but just don't have time to contribute, that's fine.
> There are other easy ways to support the project and show your appreciation, which we
> would also be very happy about:
> - Star the project
> - Refer this project in your project's README
> - Mention the project at local meetups and tell your friends/colleagues

<!-- omit in toc -->
## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
  - [Reporting Bugs](#reporting-bugs)
  - [Suggesting Enhancements](#suggesting-enhancements)
  - [Your First Code Contribution](#your-first-code-contribution)

## Code of Conduct

This project and everyone participating in it is governed by the [Fortitude Code of
Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

## I Have a Question

Before you ask a question, it is best to search for existing
[Issues](https://github.com/PlasmaFAIR/fortitude/issues) that might help you. In case
you have found a suitable issue and still need clarification, you can write your
question in this issue.

If you then still feel the need to ask a question and need clarification, we recommend
opening an [Issue](https://github.com/PlasmaFAIR/fortitude/issues/new) and providing as
much context as you can about what you're running into. We will then take care of the
issue as soon as possible.

## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
> When contributing to this project, you must agree that you have authored 100% of the
> content, that you have the necessary rights to the content and that the content you
> contribute may be provided under the project license.

### Reporting Bugs

<!-- omit in toc -->
#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information.
Therefore, we ask you to investigate carefully, collect information and describe the
issue in detail in your report. Please complete the following steps in advance to help
us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side. If you are
  looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue
  you are having, check if there is not already a bug report existing for your bug in
  the [bug tracker](https://github.com/PlasmaFAIR/fortitudeissues?q=label%3Abug).
- Collect information about the bug:
  - Stack trace (Traceback)
  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
  - Details of your Python/Rust environment
  - Your inputs and outputs
  - Can you reliably reproduce the issue? And can you also reproduce it with older
    versions?

<!-- omit in toc -->
#### How Do I Submit a Good Bug Report?

We use GitHub issues to track bugs and errors. If you run into an issue with the
project:

- Open an [Issue](https://github.com/PlasmaFAIR/fortitude/issues/new). (Since we can't
  be sure at this point whether it is a bug or not, we ask you not to talk about a bug
  yet and not to label the issue.)
- Explain the behaviour you would expect and the actual behaviour.
- Please provide as much context as possible and describe the *reproduction steps* that
  someone else can follow to recreate the issue on their own. This usually includes your
  code. For good bug reports you should isolate the problem and create a reduced test
  case.
- Provide the information you collected in the previous section.

Once it's filed:

- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are
  no reproduction steps or no obvious way to reproduce the issue, the team will ask you
  for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag
  will not be addressed until they are reproduced.
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as
  possibly other tags (such as `critical`), and the issue will be left to be
  [implemented by someone](#your-first-code-contribution).

<!-- TODO create an issue template for bugs and errors that can be used as a guide and
that defines the structure of the information to be included, reference it here in the
description. -->


### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Fortitude,
**including completely new features and minor improvements to existing functionality**.
Following these guidelines will help maintainers and the community to understand your
suggestion and find related suggestions.

<!-- omit in toc -->
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation]() carefully and find out if the functionality is already
  covered, maybe by an individual configuration.
- Perform a [search](https://github.com/PlasmaFAIR/fortitude/issues) to see if the
  enhancement has already been suggested. If it has, add a comment to the existing issue
  instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you
  to make a strong case to convince the project's developers of the merits of this
  feature. Keep in mind that we want features that will be useful to the majority of our
  users and not just a small subset. If you're just targeting a minority of users,
  consider instead forking the library for your own use cases.

<!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub
issues](https://github.com/PlasmaFAIR/fortitude/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details
  as possible.
- **Explain why this enhancement would be useful** to most Fortitude users. You may also
  want to point out other projects that solved it better and which could serve as
  inspiration.

<!-- TODO create an issue template for enhancement suggestions that can be used as a
guide and that defines the structure of the information to be included, reference it
here in the description. -->

### Your First Code Contribution

Please read [README.dev.md](README.dev.md) for information on how to compile the code
from source and how to maintain good code style.

Some good first contributions include:

- Add to the documentation or fix any errors you spot.
- Expand the testing suite to improve coverage.
- Add a new linter rule 

<!-- TODO include details of how to contribute to docs, tests, rules, etc. -->

<!-- omit in toc -->
## Attribution

This guide is based on the **contributing-gen**. [Make your
own](https://github.com/bttger/contributing-gen)!