Skip to content

Commit 898a4ef

Browse files
authored
Merge pull request #175 from interkosmos/master
Updated formatting
2 parents c492ac3 + 83a89d4 commit 898a4ef

File tree

3 files changed

+244
-249
lines changed

3 files changed

+244
-249
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Contributing to the Fortran Package Manager
22

3-
Thank you for considering contributing to the Fortran Package Manager (fpm).
3+
Thank you for considering contributing to the Fortran Package Manager (*fpm*).
44
Please review and follow these guidelines to make the contribution process
5-
simple and effective for all involved.
6-
It will help communicate that you respect the time of the community
7-
developers.
8-
In return, the community will help address your problem, evaluate changes, and
9-
guide you through your pull requests.
5+
simple and effective for all involved. It will help communicate that you
6+
respect the time of the community developers. In return, the community will
7+
help address your problem, evaluate changes, and guide you through your pull
8+
requests.
109

11-
By contributing to fpm, you certify that you own or are allowed to share the
10+
By contributing to *fpm*, you certify that you own or are allowed to share the
1211
content of your contribution under the
1312
[fpm license](https://github.com/fortran-lang/fpm/blob/master/LICENSE).
1413

@@ -28,21 +27,21 @@ This allows us to focus on substance rather than style.
2827

2928
## Reporting a bug
3029

31-
A bug is a _demonstrable problem_ caused by the code in this repository.
30+
A bug is a *demonstrable problem* caused by the code in this repository.
3231
Good bug reports are extremely valuable to us—thank you!
3332

3433
Before opening a bug report:
3534

36-
1. Check if the issue has already been reported.
37-
([issues](https://github.com/fortran-lang/fpm/issues))
35+
1. Check if the issue has already been reported
36+
([issues](https://github.com/fortran-lang/fpm/issues)).
3837
2. Check if it is still an issue or it has been fixed?
3938
Try to reproduce it with the latest version from the master branch.
4039
3. Isolate the problem and create a minimal test case.
4140

4241
A good bug report should include all information needed to reproduce the bug.
4342
Please be as detailed as possible:
4443

45-
1. Which version of fpm are you using? Please be specific.
44+
1. Which version of *fpm* are you using? Please be specific.
4645
2. What are the steps to reproduce the issue?
4746
3. What is the expected outcome?
4847
4. What happens instead?
@@ -52,40 +51,38 @@ minimal back-and-forth.
5251

5352
## Suggesting a feature
5453

55-
Before suggesting a new feature, take a moment to find out if it fits
56-
the scope of the project, or if it has already been discussed.
57-
It is up to you to provide a strong argument to convince the community of the
58-
benefits of this feature.
59-
Please provide as much detail and context as possible.
60-
If applicable, include a mocked-up snippet of what the output or behavior would
61-
look like with this feature implemented.
62-
"Crazy", out-of-the-box ideas are especially welcome.
63-
It's quite possible that we are not considering an unusually creative solution.
54+
Before suggesting a new feature, take a moment to find out if it fits the scope
55+
of the project, or if it has already been discussed. It is up to you to provide
56+
a strong argument to convince the community of the benefits of this feature.
57+
Please provide as much detail and context as possible. If applicable, include a
58+
mocked-up snippet of what the output or behavior would look like with this
59+
feature implemented. “Crazy”, out-of-the-box ideas are especially welcome.
60+
It’s quite possible that we are not considering an unusually creative solution.
6461

6562
## Workflow
6663

67-
fpm is a community project.
68-
There is no one single person making final decisions.
69-
This is the workflow that we follow:
64+
*fpm* is a community project. There is no one single person making final
65+
decisions. This is the workflow that we follow:
7066

7167
1. Open a [new issue](https://github.com/fortran-lang/fpm/issues/new) to
7268
describe a bug or propose a new feature.
7369
Refer to the earlier sections on how to write a good bug report or feature
7470
request.
7571
2. Discuss with the community and reach majority consensus about what should be
7672
done about the bug or feature request.
77-
We define "majority" loosely as 80%.
73+
We define majority loosely as 80%.
7874
This means that at least 4 of 5 people engaged in the discussion should be
7975
able to agree on the next step.
8076
This allows us to have the community mostly agree while not getting stuck if
8177
one person disagrees.
8278
At this stage, the scope of the fix/feature, its behavior, and API if
8379
applicable should be defined.
84-
Only when you have community concensus on these items you should proceed
85-
to writing code and opening a PR.
86-
__When actively working on code towards a PR, please assign yourself to the issue on github.__
87-
This is good collaborative practice to avoid duplicated effort and also inform others what you
88-
are currently working on.
80+
Only when you have community concensus on these items you should proceed to
81+
writing code and opening a PR.
82+
**When actively working on code towards a PR, please assign yourself to the
83+
issue on GitHub.**
84+
This is good collaborative practice to avoid duplicated effort and also
85+
inform others what you are currently working on.
8986
3. Open a new Pull Request (PR) with your contribution.
9087
The body of the PR should at least include a bullet-point summary of the
9188
changes, and a detailed description is encouraged.
@@ -96,17 +93,16 @@ This is the workflow that we follow:
9693
sufficient.
9794
For implementation of bigger features, request 3 to 4 or more reviewers.
9895
Ideally, request reviewers that participated in step 2.
99-
5. If your PR implements a feature that adds or changes the behavior of fpm,
96+
5. If your PR implements a feature that adds or changes the behavior of *fpm*,
10097
your PR must also include appropriate changes to the documentation.
10198

10299
This workflow can evolve and change over time as we learn how best to work
103-
together.
104-
If you have an idea on how to improve the workflow itself, please open an issue
105-
and we'll discuss it.
100+
together. If you have an idea on how to improve the workflow itself, please
101+
open an issue and we’ll discuss it.
106102

107103
## General guidelines
108104

109-
* A PR should implement _only one_ feature or bug fix.
105+
* A PR should implement *only one* feature or bug fix.
110106
* Do not commit changes to files that are irrelevant to your feature or bug fix.
111107
* Smaller PRs are better than large PRs, and will lead to a shorter review and
112108
merge cycle
@@ -115,12 +111,12 @@ and we'll discuss it.
115111
* Again, please follow the
116112
[Fortran stdlib style guide](https://github.com/fortran-lang/stdlib/blob/master/STYLE_GUIDE.md).
117113

118-
## For New Contributors
114+
## For new contributors
119115

120116
If you have never created a pull request before, welcome :tada:.
121117
You can learn how from
122118
[this great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
123119

124-
Don't know where to start?
120+
Dont know where to start?
125121
You can start by looking through the list of
126-
[open issues](https://github.com/fortran-lang/fpm/issues).
122+
[open issues](https://github.com/fortran-lang/fpm/issues).

0 commit comments

Comments
 (0)