/
CONTRIBUTING.html
121 lines (92 loc) · 4.5 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
<!DOCTYPE html>
<html>
<head>
<title>Author Carpentry</title>
<link rel="stylesheet" href="css/site.css">
</head>
<body>
<header>
<a href="http://authorcarpentry.github.io"><img src="img/AClogo.jpg" alt="Author Carpentry logo"></a>
</header>
<nav>
<ul>
<li><a href=".">Lesson</a></li>
<li><a href="00-getting-started.html">Getting started</a></li>
<li><a href="01-rstudio-in-container.html">RStudio</a></li>
<li><a href="02-jupyter-in-container.html">Jupyter</a></li>
<li><a href="03-transfer-and-archive.html">Transfer & Archive</a></li>
<li><a href="06-dockerfile.html">Dockerfile</a></li>
<li><a href="mailto:daniel.nuest@uni-muenster.de">Contact Us</a></li>
</ul>
</nav>
<section>
<h1>Contributing</h1>
<p><a href="http://authorcarpentry.github.io">AuthorCarpentry</a> is an open source project,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
and reviews of proposed changes are all welcome.</p>
<h2>Contributor Agreement</h2>
<p>By contributing,
you agree that we may redistribute your work under <a href="LICENSE.md">our license</a>.
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.
Everyone involved in <a href="http://authorcarpentry.github.io">Author Carpentry</a>
agrees to abide by our <a href="CONDUCT.md">code of conduct</a>.</p>
<h2>Editing Lesson Content</h2>
<p>All lesson content is written in markdown (.md) files. We use <a href="https://github.com/caltechlibrary/mkpage">mkpage</a>
to render lesson content into .html pages. While GitHub can render content, we use mkpage so lesson content can
be viewed independent from a web connection. You’ll need to download and install mkpage before adding content.</p>
<h2>Working With GitHub</h2>
<ol>
<li><p>Fork the <code>authorcarpentry/lesson-name</code> repository on GitHub.</p></li>
<li><p>The default branch in our lessons is <code>gh-pages</code>. Create a
new branch for your changes.<br />
Give your branch a meaningful name,
such as <code>fixing-typos-in-shell-lesson</code>
or <code>adding-tutorial-on-visualization</code>.</p></li>
<li><p>Clone this repository and branch to work with it on your computer.<br />
git clone the repository with -b ‘branch name’</p></li>
<li><p>Make your changes to the .md files</p></li>
<li><p>Render your content by typing ./mk-website.bash</p></li>
<li><p>(Optional) View your changes locally by typing ‘ws’ and pointing your web browser to <a href="http://localhost:8000">http://localhost:8000</a></p></li>
<li><p>Upload your changes to GitHub by typing ./publish.bash (Does a commit and push)</p></li>
<li><p>Send a pull request to the <code>gh-pages</code> branch of the main datacarpentry
repository at <a href="http://github.com/authorcarpentry/lesson-name">http://github.com/authorcarpentry/lesson-name</a>. This can
be done through the github web interface.</p></li>
</ol>
<p>If it is easier for you to send them to us some other way,
please mail us at <a href="mailto:authorcarpentry@library.caltech.edu">authorcarpentry@library.caltech.edu</a>.
Given a choice between you creating content or wrestling with Git,
we’d rather have you doing the former.</p>
<h2>Locations and Formats</h2>
<p>Every lesson has a repository of its own, while individual topics are files
in that directory. For example, the <code>shell-ecology</code> directory holding our
introduction to the shell for ecology contains the files <code>00-intro.md</code>,
<code>01-filedir.md</code> and so on. (We use two digits followed by a one-word topic
key to ensure files
appear in the right order when listed.)</p>
<h2>Formatting of the material</h2>
<p>To ensure a consistent formatting of the lessons, we recommend the following
guidelines:</p>
<ul>
<li>No trailing white space</li>
<li>Wrap lines at 80 characters (unless it breaks URLs)</li>
</ul>
<h2>FAQ</h2>
<p><em>Where can I get help?</em></p>
<p>Mail us at <a href="mailto:authorcarpentry@library.caltech.edu">authorcarpentry@library.caltech.edu</a></p>
</section>
<footer>
<span>© 2017 <a href="https://nordholmen.net">Daniel Nüst</a></span>
<!-- original footer, removed by DN
<span>© 2017 <a href="http://library.caltech.edu/CLS_Copyright.htm">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 2-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
-->
</footer>
</body>
</html>