You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to ESMValTool tutorial
2
2
3
-
[ESMValTool][ESMValTool-site] tutorial is an open-source project and we greatly value contributions of all kinds: fixes to this tutorial, bug reports, reviews of pull requests, infrastructure improvements, community help, and outreach. We value the time you invest in contributing and strive to make the process as easy as possible. If you have suggestions for improving the process of contributing, please open an [issue][issues] by choosing the ``Suggestion`` template in the ``issues`` tab of this repository.
3
+
[ESMValTool][ESMValTool-site] tutorial is an open-source project and we greatly value contributions of all kinds: fixes to this tutorial, bug reports, reviews of pull requests, infrastructure improvements, community help, and outreach. We value the time you invest in contributing and strive to make the process as easy as possible. If you have suggestions for improving the process of contributing, please open an [issue][issues]. To do so, click on `new issue`in the ``issues`` tab of this repository and choose the ``Suggestion`` template.
4
4
5
5
## Acknowledgement
6
6
@@ -17,26 +17,25 @@ Everyone involved in this [tutorial](tutorial-repo) agrees to abide by our [code
17
17
There are many ways to contribute:
18
18
19
19
* If you do not have a [GitHub][github] account,
20
-
you can [send us comments by email][email].
20
+
you can send us comments by [email][email].
21
21
However,
22
22
we will be able to respond more quickly when you use one of the other methods described below.
23
23
24
24
* If you have a [GitHub][github] account, work in this [repository][tutorial-repo],
25
-
which can be viewed at the [tutorial site][tutorial-site].
25
+
which can be viewed at the tutorial [site][tutorial-site].
26
26
You can ask your questions, report problems or suggest improvements by [creating an issue][issues].
27
27
This is the easiest way to tell us about your ideas, and a good way to introduce yourself
28
28
and to meet some of our community members.
29
29
This allows us to assign the item to someone and to respond to it in a threaded discussion.
30
-
There are several templates to make an issue:
31
-
* for asking a question, please use [Question and answer][issues]
32
-
* for reporting a bug, please use [Bug reports][issues]
33
-
* for developing lesson material, please use [New lesson material][issues]
34
-
* for adding a feature to the repository, please use [Suggestion][issues]
30
+
To open an issue, click on `new issue` in the ``issues`` tab of this repository and choose a template from the list as described below:
31
+
* for asking a question, please use `Question and answer`.
32
+
* for reporting a bug, please use `Bug reports`.
33
+
* for developing lesson material, please use `New lesson material`.
34
+
* for adding a feature to the repository, please use `Suggestion`.
35
35
36
36
* If you would like to add what is already discussed in an issue,
37
-
you can submit a [pull request][PR].
38
-
To do so, you can make use of the [pull request checklist][PR].
39
-
Each pull request is reviewed at least by one reviewer who is a community volunteer and provides feedback.
37
+
you can submit a [pull request][PR] and make use of the `pull request checklist`.
38
+
Each pull request is reviewed at least by one reviewer who is a community volunteer.
40
39
The [maintainers][tutorial-maintainers] have final say over what gets merged into the tutorial.
41
40
42
41
## Tutorial guidelines
@@ -60,8 +59,9 @@ Each lesson is made up of episodes, which are focused on a particular topic and
60
59
### Lesson formatting
61
60
62
61
Episodes files are [Markdown](https://en.wikipedia.org/wiki/Markdown) files. If you are making a new episode or contributing to existing ones, please make sure the content conforms to the [Carpentries lesson formatting][swc-lesson-formatting].
63
-
We recommend using a linter to check errors in Markdown files.
64
-
For example, a [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) can be installed as an extension in ``Visual Studio Code``.
62
+
63
+
We also, recommend using a linter to check errors in Markdown files.
64
+
For example, a [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) can be installed as an extension in [Visual Studio Code](https://code.visualstudio.com/).
65
65
Alternatively, a linter can be installed with:
66
66
67
67
```bash
@@ -74,10 +74,11 @@ and can be used as:
74
74
mdl your_markdown_filename
75
75
```
76
76
77
-
## Previewing your changes locally
77
+
###Previewing your changes locally
78
78
79
-
Please preview changes on your machine before pushing them to GitHub.
80
-
To do so, you need to install the software described below.
79
+
If you are making a new episode or contributing to existing ones,
80
+
please preview changes on your machine before submitting a [pull request][PR].
81
+
To do so, you need to install the software described below:
81
82
82
83
```bash
83
84
# apt (Ubuntu/Devian)
@@ -115,7 +116,7 @@ This address can be opened in your browser to preview the tutorial website.
115
116
## Other Resources
116
117
117
118
General discussion of the tutorial happens in `User Engagement Team`.
0 commit comments