Skip to content

Commit 3e001c8

Browse files
bouweandelabouweandela
authored
Merge pull request #23 from ESMValGroup/update_contributing
restructuring the contributing.md file
2 parents e488ee6 + 075878b commit 3e001c8

File tree

1 file changed

+96
-142
lines changed

1 file changed

+96
-142
lines changed

‎CONTRIBUTING.md‎

Lines changed: 96 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -1,180 +1,134 @@
1-
# Contributing
1+
# Contributing to ESMValTool tutorial
22

3-
The format of this tutorial is based on the [The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]), which are open source projects. We welcome contributions of all kinds:
4-
fixes to this tutorial,
5-
bug reports,
6-
and reviews of proposed changes are all welcome.
3+
[ESMValTool][tutorial-site] tutorial is an open-source project in [ESMValGroup][ESMValTool-site] 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.
74

8-
## Contributor Agreement
5+
## Acknowledgement
96

10-
By contributing,
11-
you agree that we may redistribute your work under [our license](LICENSE.md).
12-
In exchange,
13-
we will address your issues and/or assess your change proposal as promptly as we can,
14-
and help you become a member of our community.
15-
Everyone involved in [The Carpentries][c-site]
16-
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
7+
The format of this tutorial is based on the [Software Carpentry][swc-site], which is an open-source project.
8+
9+
## Agreement
10+
11+
By contributing, you agree that we may redistribute your work under [our license](LICENSE.md).
12+
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.
13+
Everyone involved in this [tutorial](tutorial-repo) agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
1714

1815
## How to Contribute
1916

20-
The easiest way to get started is to file an issue
21-
to tell us about a spelling mistake,
22-
some awkward wording,
23-
or a factual error.
24-
This is a good way to introduce yourself
17+
There are many ways to contribute:
18+
19+
* If you do not have a [GitHub][github] account,
20+
you can send us comments by [email][email].
21+
However,
22+
we will be able to respond more quickly when you use one of the other methods described below.
23+
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].
26+
You can ask your questions, report problems or suggest improvements by [creating an issue][issues].
27+
This is the easiest way to tell us about your ideas, and a good way to introduce yourself
2528
and to meet some of our community members.
29+
This allows us to assign the item to someone and to respond to it in a threaded discussion.
30+
To open an issue, click on `New issue` in the `issues` tab of this repository and choose a template from the [list](https://github.com/ESMValGroup/tutorial/issues/new/choose) 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+
36+
* If you would like to add what is already discussed in an issue,
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.
39+
The [maintainers][tutorial-maintainers] have final say over what gets merged into the tutorial.
40+
41+
## Tutorial guidelines
42+
43+
This section demonstrates all the instructions for developing a lesson in the [ESMValTool tutorial][tutorial-site].
44+
The tutorial is a set of lessons (or episodes) that together teach **basic** skills needed to work with [ESMValTool][ESMValTool-doc] in climate-related domains.
45+
46+
### Lesson development
47+
48+
The content of this tutorial is mainly developed based on the [Carpentries Curriculum Development Handbook][swc-handbook]. The handbook explains why we teach the way we do, and why our lessons are designed the way they are.
49+
If you are contributing to existing lesson materials, please make sure the content conforms to the concepts provided in the handbook.
50+
51+
We recommend using software to check spelling or grammatical errors.
52+
The following link will guide you through a list of tools for several editors:
53+
<http://wiki.languagetool.org/software-that-supports-languagetool-as-a-plug-in-or-add-on>
54+
55+
### Lesson organization
56+
57+
Each lesson is made up of episodes, which are focused on a particular topic and include time for both teaching and exercises. If you are making a new episode, please make sure the content conforms to the [Carpentries lesson organization][swc-lesson-organization].
58+
59+
### Lesson formatting
60+
61+
Episodes 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].
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+
Alternatively, a linter can be installed with:
66+
67+
```bash
68+
gem install mdl
69+
```
70+
71+
and can be used as:
72+
73+
```bash
74+
mdl your_markdown_filename
75+
```
76+
77+
### Previewing your changes locally
78+
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:
2682

27-
1. If you do not have a [GitHub][github] account,
28-
you can [send us comments by email][email].
29-
However,
30-
we will be able to respond more quickly if you use one of the other methods described below.
31-
32-
2. If you have a [GitHub][github] account,
33-
or are willing to [create one][github-join],
34-
but do not know how to use Git,
35-
you can report problems or suggest improvements by [creating an issue][issues].
36-
This allows us to assign the item to someone
37-
and to respond to it in a threaded discussion.
38-
39-
3. If you are comfortable with Git,
40-
and would like to add or change material,
41-
you can submit a pull request (PR).
42-
Instructions for doing this are [included below](#using-github).
43-
44-
## Where to Contribute
45-
46-
1. If you wish to change this tutorial,
47-
please work in <https://github.com/esmvalgroup/tutorial>,
48-
which can be viewed at <https://esmvalgroup.github.io/tutorial>.
49-
50-
2. If you wish to change the Carpentries example lesson,
51-
please work in <https://github.com/carpentries/lesson-example>,
52-
which documents the format of the Carpentry lessons
53-
and can be viewed at <https://carpentries.github.io/lesson-example>.
54-
55-
3. If you wish to change the template used for Carpentry workshop websites,
56-
please work in <https://github.com/carpentries/workshop-template>.
57-
The home page of that repository explains how to set up Carpentry workshop websites,
58-
while the extra pages in <https://carpentries.github.io/workshop-template>
59-
provide more background on our design choices.
60-
61-
4. If you wish to change CSS style files, tools,
62-
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
63-
please work in <https://github.com/carpentries/styles>.
64-
65-
## What to Contribute
66-
67-
There are many ways to contribute,
68-
from writing new exercises and improving existing ones
69-
to updating or filling in the documentation
70-
and submitting [bug reports][issues]
71-
about things that don't work, aren't clear, or are missing.
72-
If you are looking for ideas, please see the 'Issues' tab for
73-
a list of issues associated with this repository,
74-
or you may also look at the issues for [Data Carpentry][dc-issues],
75-
[Software Carpentry][swc-issues], and [Library Carpentry][lc-issues] projects.
76-
77-
Comments on issues and reviews of pull requests are just as welcome:
78-
we are smarter together than we are on our own.
79-
Reviews from novices and newcomers are particularly valuable:
80-
it's easy for people who have been using these lessons for a while
81-
to forget how impenetrable some of this material can be,
82-
so fresh eyes are always welcome.
83-
84-
## What *Not* to Contribute
85-
86-
Our lessons already contain more material than we can cover in a typical workshop,
87-
so we are usually *not* looking for more concepts or tools to add to them.
88-
As a rule,
89-
if you want to introduce a new idea,
90-
you must (a) estimate how long it will take to teach
91-
and (b) explain what you would take out to make room for it.
92-
The first encourages contributors to be honest about requirements;
93-
the second, to think hard about priorities.
94-
95-
We are also not looking for exercises or other material that only run on one platform.
96-
Our workshops typically contain a mixture of Windows, macOS, and Linux users;
97-
in order to be usable,
98-
our lessons must run equally well on all three.
99-
100-
## Using GitHub
101-
102-
If you choose to contribute via GitHub, you may want to look at
103-
[How to Contribute to an Open Source Project on GitHub][how-contribute].
104-
To manage changes, we follow [GitHub flow][github-flow].
105-
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
106-
The maintainers are community volunteers and have final say over what gets merged into the lesson.
107-
To use the web interface for contributing to a lesson:
108-
109-
1. Fork the originating repository to your GitHub profile.
110-
2. Within your version of the forked repository, move to the `gh-pages` branch and
111-
create a new branch for each significant change being made.
112-
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
113-
4. Commit all changed files within the appropriate branches.
114-
5. Create individual pull requests from each of your changed branches
115-
to the `gh-pages` branch within the originating repository.
116-
6. If you receive feedback, make changes using your issue-specific branches of the forked
117-
repository and the pull requests will update automatically.
118-
7. Repeat as needed until all feedback has been addressed.
119-
120-
When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
121-
before creating your own revision-specific branch(es) from there.
122-
Additionally, please only work from your newly-created branch(es) and *not*
123-
your clone of the originating `gh-pages` branch.
124-
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
125-
repository for reference while revising.
126-
127-
## Previewing your changes locally
128-
129-
Extensive instructions for building and viewing the pages locally can be found [here](https://carpentries.github.io/lesson-example/setup.html). To get started quickly, run
13083
```bash
13184
# apt (Ubuntu/Devian)
13285
sudo apt install ruby-dev ruby-bundler
13386
```
87+
13488
or
89+
13590
```bash
13691
# dnf (Fedora/Redhat)
13792
sudo dnf install rubygem-bundler ruby-devel
13893
```
13994

140-
Alternatively, there's an environment file available which can be installed in conda with:
95+
Alternatively, there is an environment file available which can be installed with:
96+
14197
```bash
14298
conda env create -f environment.yml -n esmvaltool_tutorial
14399
```
144100

145101
To install the required ruby packages, run the following command in the tutorial's
146102
main directory to build and serve the website locally:
103+
147104
```bash
148105
make serve
149106
```
150107

151108
The output on the terminal will contain a line similar to:
152-
```
109+
110+
```bash
153111
Server address: http://127.0.0.1:4000
154112
```
155-
This address can be opened in your browser to preview the website.
156113

114+
This address can be opened in your browser to preview the tutorial website.
157115

158116
## Other Resources
159117

160-
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
161-
happens on the [discussion mailing list][discuss-list],
162-
which everyone is welcome to join.
163-
You can also [reach us by email][email].
118+
General discussion of the tutorial happens in `User Engagement Team`.
119+
You can reach us by [email][email].
164120

165-
[email]: mailto:[email protected]
166-
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
167-
[dc-lessons]: http://datacarpentry.org/lessons/
168-
[dc-site]: http://datacarpentry.org/
169-
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
121+
[email]: mailto:TODO_FIX_ME
122+
[ESMValTool-site]: https://www.esmvaltool.org/
123+
[ESMValTool-doc]: https://esmvaltool.readthedocs.io/en/latest/
124+
[tutorial-repo]: https://esmvalgroup.github.io/tutorial/
125+
[tutorial-site]: https://esmvalgroup.github.io/tutorial
126+
[tutorial-maintainers]: https://github.com/ESMValGroup/tutorial#maintainers
170127
[github]: https://github.com
171-
[github-flow]: https://guides.github.com/introduction/flow/
172-
[github-join]: https://github.com/join
173-
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
174-
[issues]: https://guides.github.com/features/issues/
175-
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
176-
[swc-lessons]: https://software-carpentry.org/lessons/
128+
[issues]: https://github.com/ESMValGroup/tutorial/issues
129+
[PR]: https://github.com/ESMValGroup/tutorial/pulls
177130
[swc-site]: https://software-carpentry.org/
178-
[c-site]: https://carpentries.org/
179-
[lc-site]: https://librarycarpentry.org/
180-
[lc-issues]: https://github.com/issues?q=user%3Alibrarycarpentry
131+
[swc-handbook]: https://carpentries.github.io/curriculum-development/
132+
[swc-lesson-organization]: https://carpentries.github.io/lesson-example/03-organization/index.html
133+
[swc-lesson-formatting]: https://carpentries.github.io/lesson-example/04-formatting/index.html
134+
[ea-site]: https://github.com/escience-academy

0 commit comments

Comments
 (0)