Skip to content

Commit 65aecff

Browse files
committed
add text to the section tutorial guidelines
1 parent 9033e5b commit 65aecff

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to ESMValTool tutorial
22

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.
44

55
## Acknowledgement
66

@@ -11,7 +11,7 @@ The format of this tutorial is based on the [Software Carpentry][swc-site], whic
1111

1212
By contributing, you agree that we may redistribute your work under [our license](LICENSE.md).
1313
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).
1515

1616
## How to Contribute
1717

@@ -24,8 +24,8 @@ we will be able to respond more quickly if you use one of the other methods desc
2424

2525
* If you have a [GitHub][github] account,
2626
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].
2929
You can ask your questions, report problems or suggest improvements by [creating an issue][issues].
3030
This is the easiest way to tell us about your ideas,
3131
and a good way to introduce yourself
@@ -44,23 +44,24 @@ To do so, you can make use of the [pull request checklist][PR].
4444
The reviewers are community volunteers who provide feedback.
4545
The maintainers have final say over what gets merged into the tutorial.
4646

47-
## Tutorial content guides
47+
## Tutorial guidelines
4848

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.
5151

5252
### Lesson development
5353

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.
5556

5657
### Lesson organization
5758

58-
https://carpentries.github.io/lesson-example/03-organization/index.html
59+
[swc-lesson-organization]
5960

6061

6162
### Lesson formatting
62-
63-
https://carpentries.github.io/lesson-example/04-formatting/index.html
63+
[RMarkdown](https://rmarkdown.rstudio.com/)
64+
[swc-lesson-formatting]
6465

6566
## Previewing your changes locally
6667

@@ -108,7 +109,9 @@ which everyone is welcome to join.
108109
You can also [reach us by email][email].
109110

110111
[email]: mailto:[email protected]
111-
[site]: https://esmvalgroup.github.io/tutorial/
112+
[ESMValTool-site]: https://www.esmvaltool.org/
113+
[tutorial-repo]: https://esmvalgroup.github.io/tutorial/
114+
[tutorial-site]: https://esmvalgroup.github.io/tutorial
112115
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
113116
[github]: https://github.com
114117
[github-flow]: https://guides.github.com/introduction/flow/
@@ -120,6 +123,8 @@ You can also [reach us by email][email].
120123
[swc-lessons]: https://software-carpentry.org/lessons/
121124
[swc-site]: https://software-carpentry.org/
122125
[swc-handbook]: https://carpentries.github.io/curriculum-development/
126+
[swc-lesson-organization]: https://carpentries.github.io/lesson-example/03-organization/index.html
127+
[swc-lesson-formatting]: https://carpentries.github.io/lesson-example/04-formatting/index.html
123128
[ea-site]: https://github.com/escience-academy
124129
[c-site]: https://carpentries.org/
125130
[lc-site]: https://librarycarpentry.org/

0 commit comments

Comments
 (0)