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
+17-12Lines changed: 17 additions & 12 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](https://www.esmvaltool.org/) 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] by choosing the ``Suggestion`` template in the ``issues`` tab of this repository.
4
4
5
5
## Acknowledgement
6
6
@@ -11,7 +11,7 @@ The format of this tutorial is based on the [Software Carpentry][swc-site], whic
11
11
12
12
By contributing, you agree that we may redistribute your work under [our license](LICENSE.md).
13
13
In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community.
14
-
Everyone involved in this [tutorial](site) agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
14
+
Everyone involved in this [tutorial](tutorial-repo) agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
15
15
16
16
## How to Contribute
17
17
@@ -24,8 +24,8 @@ we will be able to respond more quickly if you use one of the other methods desc
24
24
25
25
* If you have a [GitHub][github] account,
26
26
or are willing to [create one][github-join],
27
-
please work in this [repository][site],
28
-
which can be viewed at <https://esmvalgroup.github.io/tutorial>.
27
+
please work in this [repository][tutorial-repo],
28
+
which can be viewed at the [tutorial site][tutorial-site].
29
29
You can ask your questions, report problems or suggest improvements by [creating an issue][issues].
30
30
This is the easiest way to tell us about your ideas,
31
31
and a good way to introduce yourself
@@ -44,23 +44,24 @@ To do so, you can make use of the [pull request checklist][PR].
44
44
The reviewers are community volunteers who provide feedback.
45
45
The maintainers have final say over what gets merged into the tutorial.
46
46
47
-
## Tutorial content guides
47
+
## Tutorial guidelines
48
48
49
-
This section demonstrates all the features that can be used when developing a lesson in [RMarkdown] (https://rmarkdown.rstudio.com/).
50
-
TODO level
49
+
This section demonstrates all the instructions for developing a lesson in the [ESMValTool tutorial][tutorial-site].
50
+
The tutorial is a set of lessons (or episodes) that together teach **basic** skills needed to work with [ESMValTool][ESMValTool-site] in climate-related domains.
51
51
52
52
### Lesson development
53
53
54
-
The content of this tutorial is developed based on the [Carpentries Curriculum Development Handbook][swc-handbook].
54
+
The content of this tutorial is mainly developed based on the [Carpentries Curriculum Development Handbook][swc-handbook].
55
+
The handbook explains why we teach the way we do, and why our lessons are designed the way they are.
0 commit comments