1
1
# Contributing to the Fortran Package Manager
2
2
3
- Thank you for considering contributing to the Fortran Package Manager (fpm).
3
+ Thank you for considering contributing to the Fortran Package Manager (* fpm* ).
4
4
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.
10
9
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
12
11
content of your contribution under the
13
12
[ fpm license] ( https://github.com/fortran-lang/fpm/blob/master/LICENSE ) .
14
13
@@ -28,21 +27,21 @@ This allows us to focus on substance rather than style.
28
27
29
28
## Reporting a bug
30
29
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.
32
31
Good bug reports are extremely valuable to us—thank you!
33
32
34
33
Before opening a bug report:
35
34
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 ) ).
38
37
2 . Check if it is still an issue or it has been fixed?
39
38
Try to reproduce it with the latest version from the master branch.
40
39
3 . Isolate the problem and create a minimal test case.
41
40
42
41
A good bug report should include all information needed to reproduce the bug.
43
42
Please be as detailed as possible:
44
43
45
- 1 . Which version of fpm are you using? Please be specific.
44
+ 1 . Which version of * fpm* are you using? Please be specific.
46
45
2 . What are the steps to reproduce the issue?
47
46
3 . What is the expected outcome?
48
47
4 . What happens instead?
@@ -52,40 +51,38 @@ minimal back-and-forth.
52
51
53
52
## Suggesting a feature
54
53
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.
64
61
65
62
## Workflow
66
63
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:
70
66
71
67
1 . Open a [ new issue] ( https://github.com/fortran-lang/fpm/issues/new ) to
72
68
describe a bug or propose a new feature.
73
69
Refer to the earlier sections on how to write a good bug report or feature
74
70
request.
75
71
2 . Discuss with the community and reach majority consensus about what should be
76
72
done about the bug or feature request.
77
- We define " majority" loosely as 80%.
73
+ We define “ majority” loosely as 80%.
78
74
This means that at least 4 of 5 people engaged in the discussion should be
79
75
able to agree on the next step.
80
76
This allows us to have the community mostly agree while not getting stuck if
81
77
one person disagrees.
82
78
At this stage, the scope of the fix/feature, its behavior, and API if
83
79
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.
89
86
3 . Open a new Pull Request (PR) with your contribution.
90
87
The body of the PR should at least include a bullet-point summary of the
91
88
changes, and a detailed description is encouraged.
@@ -96,17 +93,16 @@ This is the workflow that we follow:
96
93
sufficient.
97
94
For implementation of bigger features, request 3 to 4 or more reviewers.
98
95
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* ,
100
97
your PR must also include appropriate changes to the documentation.
101
98
102
99
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.
106
102
107
103
## General guidelines
108
104
109
- * A PR should implement _ only one _ feature or bug fix.
105
+ * A PR should implement * only one * feature or bug fix.
110
106
* Do not commit changes to files that are irrelevant to your feature or bug fix.
111
107
* Smaller PRs are better than large PRs, and will lead to a shorter review and
112
108
merge cycle
@@ -115,12 +111,12 @@ and we'll discuss it.
115
111
* Again, please follow the
116
112
[ Fortran stdlib style guide] ( https://github.com/fortran-lang/stdlib/blob/master/STYLE_GUIDE.md ) .
117
113
118
- ## For New Contributors
114
+ ## For new contributors
119
115
120
116
If you have never created a pull request before, welcome :tada : .
121
117
You can learn how from
122
118
[ this great tutorial] ( https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github ) .
123
119
124
- Don' t know where to start?
120
+ Don’ t know where to start?
125
121
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