forked from swcarpentry/DEPRECATED-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.html
267 lines (236 loc) · 8.44 KB
/
contributing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
---
layout: base
root: .
title: How to Contribute
---
<p>
Software Carpentry is an open project.
Like all such projects,
it needs your help to grow,
and you can contribute in many ways,
large and small.
</p>
<div>
<h3 id="discuss">Discuss</h3>
<p>
To stay up to date with us,
you can follow <a href="{{page.root}}/blog">our blog</a>
or sign up for our low-traffic announcement mailing list
(approximately 2-3 emails a month):
</p>
<form class="form-inline" method="post" style="text-align:center" action="http://scripts.dreamhost.com/add_list.cgi">
<fieldset>
<input type="hidden" name="list" value="software-carpentry" />
<input type="hidden" name="domain" value="software-carpentry.org" />
<input type="hidden" name="emailit" value="1" />
<input type="text" name="name" placeholder="Full name" />
<input type="text" name="email" placeholder="Email"/>
<button type="submit" class="btn" name="submit" value="Join">Join</button>
<button type="submit" class="btn" name="unsub" value="Unsubscribe">Unsubscribe</button>
</fieldset>
</form>
<p>
We also run these higher-traffic mailing lists:
</p>
<table class="table table-striped">
<tr>
<td>
<a href="{{site.listserv_url}}/discuss-software-carpentry.org">discuss</a>
</td>
<td>
The main channel for discussion of direction and technology.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/tutors-software-carpentry.org">tutors</a>
</td>
<td>
A by-invitation list used to match instructors to boot camps.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/assessment-software-carpentry.org">assessment</a>
</td>
<td>
Where we talk about how to assess what learners already know,
what they've learned from us,
and what impact we've had.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/data-software-carpentry.org">data</a>
</td>
<td>
For discussion of a new "data carpentry" module.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/funding-software-carpentry.org">funding</a>
</td>
<td>
A by-invitation list for discussion of funding models.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/gits-software-carpentry.org">gits</a>
</td>
<td>
For discussion of our GitHub repositories, website, and workflow.
</td>
</tr>
<tr>
<td>
<a href="{{site.listserv_url}}/r-discuss-software-carpentry.org">r-discuss</a>
</td>
<td>
For people interested in teaching R.
</td>
</tr>
</table>
</div>
<div>
<h3 id="learn">Learn</h3>
<p>
We run an online training course to help people become
instructors. The course requires 2-4 hours/week for 8-10 weeks,
and covers the basics of educational psychology, instructional
design, and how to apply both to teaching programming to
scientists. To find out more,
visit <a href="{{site.training_url}}">the course website</a>.
</p>
</div>
<div>
<h3 id="teach">Teach</h3>
<p>
All of our slides, notes, and example programs are in our Git repositories at
<a href="https://github.com/swcarpentry/bc">https://github.com/swcarpentry/bc</a>,
and
<a href="https://github.com/swcarpentry/site">https://github.com/swcarpentry/site</a>
under <a href="license.html">open access licenses</a>;
you are free to use them however you want
so long as you <a href="{{page.root}}/license.html">give us attribution</a>.
Everything is designed so that individuals can work through what they need on their own,
but universities, research labs, companies, and self-study groups have also used it
in week-long crash courses and as part of longer classroom courses.
</p>
<p>
If you would like to deliver the course
(as a Software Carpentry instructor or on your own) in one of these formats,
or in one we haven't seen yet,
please <a href="#discuss">let us know</a>—we'd be glad to offer training or advice.
</p>
<p>
Note:
there <em>are</em> restrictions on the use of our name and logo,
both of which are trademarked.
Please see <a href="faq.html#who-can-run-a-bootcamp">our FAQ</a> for details.
</p>
</div>
<div>
<h3 id="fix">Fix</h3>
<p>
If you see a mistake in on our website,
please add a comment to the appropriate page
or <a href="mailto:{{site.contact}}">mail us</a>
and we'll fix it as quickly as we can.
And of course, we always welcome pull requests (see below).
</p>
</div>
<div>
<h3 id="create">Create</h3>
<p>
If you are interested in developing the Software Carpentry content,
we have organized our materials into a few different repositories on <a href="https://github.com/swcarpentry">GitHub</a>.
</p>
<table class="table table-striped">
<tr>
<th>Repository</th>
<th>Description</th>
<th>Contributing Docs</th>
</tr>
<tr>
<td><a href="https://github.com/swcarpentry/bc">bc</a></td>
<td>The starting point for bootcamp home pages, including most of our teaching materials.</td>
<td>
<a href="https://github.com/swcarpentry/bc">README</a>
</td>
</tr>
<tr>
<td><a href="https://github.com/swcarpentry/site">site</a></td>
<td>Holds the content of our site.</td>
<td>
<a href="https://github.com/swcarpentry/site/blob/master/README.md">README</a>,
</td>
</tr>
<tr>
<td><a href="https://github.com/swcarpentry/v4">v4</a></td>
<td>
Companion repository to <a href="https://github.com/swcarpentry/site">site</a>
holding the 4.0 teaching materials: online video lectures and slides.
</td>
<td>No longer under development</td>
</tr>
<tr>
<td><a href="https://github.com/swcarpentry/v3">v3</a></td>
<td>
Companion repository to <a href="https://github.com/swcarpentry/site">site</a>
holding the 3.0 teaching materials: basic HTML pages and slides.
</td>
<td>No longer under development</td>
</tr>
<tr>
<td><a href="https://github.com/swcarpentry/assets">assets</a></td>
<td>
Supporting files for the Software Carpentry organisation (e.g. papers, logos, etc.).
</td>
<td></td>
</tr>
</table>
<p>
Pull requests are always welcome,
or you can <a href="mailto:{{site.contact}}">mail us</a>
to talk about what you'd like to do
and how we can help.
</p>
</div>
<div>
<h3>Partner</h3>
<p>
Software Carpentry is actively seeking ways to partner with other groups and initiatives
to help change what scientists do and how they do it.
</p>
<h4>EPSRC-Approved Software Training for Centres of Doctoral Training</h4>
<p>
The <a href="http://www.software.ac.uk">Software Sustainability Institute</a>
was <a href="http://gow.epsrc.ac.uk/NGBOViewGrant.aspx?GrantRef=EP/H043160/1">founded by the EPSRC</a>
as a national facility for cultivating world-class research through software.
Based at the universities of Edinburgh, Manchester, Oxford and Southampton,
it is an EPSRC-approved supplier of training for the Centres for Doctoral Training (CDT) call.
Its training packages are based on Software Carpentry,
and its training packages include instructors who will travel to your organisation and present the course,
a curriculum tailored to your requirements,
and administration of the training event,
from booking rooms to organising refreshments.
</p>
<p>
The EPSRC has recognised the fundamental importance of software in research,
and the necessity of good software development practices in producing accurate, reusable, and reproducible research.
The <a href="http://www.software.ac.uk">SSI</a>'s training courses
make it easy to meet the EPSRC's software-development requirements
without investing resources into creating new training,
and without duplicating existing training materials and courses.
</p>
<p>
For more information about how you can include the <a href="http://www.software.ac.uk">SSI</a>'s training
in your CDT bid,
please see <a href="http://www.software.ac.uk/Training-For-CDTs">the full description</a>
of what they offer,
or contact the <a href="http://www.software.ac.uk">SSI</a>'s director,
<a href="mailto:n.chuehong@software.ac.uk">Dr. Neil Chue Hong</a>.
</p>
</div>