Skip to content

Commit 09c01f0

Browse files
scanonscanon
committed
first commit
0 parents  commit 09c01f0

File tree

269 files changed

+24630
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+24630
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Please delete the text below before submitting your contribution.
2+
3+
---
4+
5+
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
6+
7+
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact Kate Hertweck ([email protected]).
8+
9+
---

‎.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Please delete the text below before submitting your contribution.
2+
3+
---
4+
5+
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
6+
7+
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact Kate Hertweck ([email protected]).
8+
9+
---

‎.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
*.sif
2+
*.pyc
3+
*~
4+
.DS_Store
5+
.ipynb_checkpoints
6+
.sass-cache
7+
__pycache__
8+
_site
9+
.vscode
10+
.jekyll-cache

‎.travis.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
language: python
2+
python:
3+
- "3.2"
4+
- "3.3"
5+
- "3.4"
6+
# command to install dependencies
7+
install:
8+
- pip install -r requirements.txt
9+
# command to run tests
10+
before_script:
11+
- "awk -i inplace 'FNR == 4 {print \"carpentry: swc\"} {print}' index.html"
12+
- "awk -i inplace 'FNR == 5 {print \"venue: Foo\"} {print}' index.html"
13+
- "awk -i inplace 'FNR == 6 {print \"address: Room 123\"} {print}' index.html"
14+
- "awk -i inplace 'FNR == 7 {print \"country: us\"} {print}' index.html"
15+
- "awk -i inplace 'FNR == 8 {print \"language: en\"} {print}' index.html"
16+
- "awk -i inplace 'FNR == 9 {print \"latlng: 0,0\"} {print}' index.html"
17+
- "awk -i inplace 'FNR == 10 {print \"humandate: Jan 01-02, 2020\"} {print}' index.html"
18+
- "awk -i inplace 'FNR == 11 {print \"humantime: 9:00 am - 4:30 pm\"} {print}' index.html"
19+
- "awk -i inplace 'FNR == 12 {print \"startdate: 2020-01-01\"} {print}' index.html"
20+
- "awk -i inplace 'FNR == 13 {print \"enddate: 2020-01-01\"} {print}' index.html"
21+
- "awk -i inplace 'FNR == 14 {print \"instructor: [Foo]\"} {print}' index.html"
22+
- "awk -i inplace 'FNR == 15 {print \"helper: [Foo]\"} {print}' index.html"
23+
- "awk -i inplace 'FNR == 16 {print \"contact: [[email protected]]\"} {print}' index.html"
24+
- "awk -i inplace 'FNR == 17 {print \"collaborative_notes: http://foo.bar\"} {print}' index.html"
25+
- "awk -i inplace 'FNR == 18 {print \"eventbrite: 1234567890AB\"} {print}' index.html"
26+
script:
27+
- python bin/workshop_check.py .
28+
branches:
29+
only:
30+
- gh-pages

‎AUTHORS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Carlos Eduardo Arango <[email protected]>
2+
Shane Canon <[email protected]>
3+
Marco De La Pierre <[email protected]>
4+
Sameer Shende <[email protected]>
5+
Andrew J. Younge <[email protected]>

‎CITATION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FIXME: describe how to cite this lesson.

‎CONDUCT.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: page
3+
title: "Contributor Code of Conduct"
4+
permalink: /conduct/
5+
---
6+
As contributors and maintainers of this project,
7+
we pledge to follow the [Carpentry Code of Conduct][coc].
8+
9+
Instances of abusive, harassing, or otherwise unacceptable behavior
10+
may be reported by following our [reporting guidelines][coc-reporting].
11+
12+
{% include links.md %}

‎CONTRIBUTING.md

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# Contributing
2+
3+
[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
4+
and we welcome contributions of all kinds:
5+
new lessons,
6+
fixes to existing material,
7+
bug reports,
8+
and reviews of proposed changes are all welcome.
9+
10+
## Contributor Agreement
11+
12+
By contributing,
13+
you agree that we may redistribute your work under [our license](LICENSE.md).
14+
In exchange,
15+
we will address your issues and/or assess your change proposal as promptly as we can,
16+
and help you become a member of our community.
17+
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
18+
agrees to abide by our [code of conduct](CONDUCT.md).
19+
20+
## How to Contribute
21+
22+
The easiest way to get started is to file an issue
23+
to tell us about a spelling mistake,
24+
some awkward wording,
25+
or a factual error.
26+
This is a good way to introduce yourself
27+
and to meet some of our community members.
28+
29+
1. If you do not have a [GitHub][github] account,
30+
you can [send us comments by email][email].
31+
However,
32+
we will be able to respond more quickly if you use one of the other methods described below.
33+
34+
2. If you have a [GitHub][github] account,
35+
or are willing to [create one][github-join],
36+
but do not know how to use Git,
37+
you can report problems or suggest improvements by [creating an issue][issues].
38+
This allows us to assign the item to someone
39+
and to respond to it in a threaded discussion.
40+
41+
3. If you are comfortable with Git,
42+
and would like to add or change material,
43+
you can submit a pull request (PR).
44+
Instructions for doing this are [included below](#using-github).
45+
46+
## Where to Contribute
47+
48+
1. If you wish to change this lesson,
49+
please work in <https://github.com/swcarpentry/FIXME>,
50+
which can be viewed at <https://swcarpentry.github.io/FIXME>.
51+
52+
2. If you wish to change the example lesson,
53+
please work in <https://github.com/swcarpentry/lesson-example>,
54+
which documents the format of our lessons
55+
and can be viewed at <https://swcarpentry.github.io/lesson-example>.
56+
57+
3. If you wish to change the template used for workshop websites,
58+
please work in <https://github.com/swcarpentry/workshop-template>.
59+
The home page of that repository explains how to set up workshop websites,
60+
while the extra pages in <https://swcarpentry.github.io/workshop-template>
61+
provide more background on our design choices.
62+
63+
4. If you wish to change CSS style files, tools,
64+
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
65+
please work in <https://github.com/swcarpentry/styles>.
66+
67+
## What to Contribute
68+
69+
There are many ways to contribute,
70+
from writing new exercises and improving existing ones
71+
to updating or filling in the documentation
72+
and submitting [bug reports][issues]
73+
about things that don't work, aren't clear, or are missing.
74+
If you are looking for ideas, please see the 'Issues' tab for
75+
a list of issues associated with this repository,
76+
or you may also look at the issues for [Data Carpentry][dc-issues]
77+
and [Software Carpentry][swc-issues] projects.
78+
79+
Comments on issues and reviews of pull requests are just as welcome:
80+
we are smarter together than we are on our own.
81+
Reviews from novices and newcomers are particularly valuable:
82+
it's easy for people who have been using these lessons for a while
83+
to forget how impenetrable some of this material can be,
84+
so fresh eyes are always welcome.
85+
86+
## What *Not* to Contribute
87+
88+
Our lessons already contain more material than we can cover in a typical workshop,
89+
so we are usually *not* looking for more concepts or tools to add to them.
90+
As a rule,
91+
if you want to introduce a new idea,
92+
you must (a) estimate how long it will take to teach
93+
and (b) explain what you would take out to make room for it.
94+
The first encourages contributors to be honest about requirements;
95+
the second, to think hard about priorities.
96+
97+
We are also not looking for exercises or other material that only run on one platform.
98+
Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
99+
in order to be usable,
100+
our lessons must run equally well on all three.
101+
102+
## Using GitHub
103+
104+
If you choose to contribute via GitHub, you may want to look at
105+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
106+
To manage changes, we follow [GitHub flow][github-flow].
107+
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
108+
The maintainers are community volunteers and have final say over what gets merged into the lesson.
109+
To use the web interface for contributing to a lesson:
110+
111+
1. Fork the originating repository to your GitHub profile.
112+
2. Within your version of the forked repository, move to the `gh-pages` branch and
113+
create a new branch for each significant change being made.
114+
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
115+
4. Commit all changed files within the appropriate branches.
116+
5. Create individual pull requests from each of your changed branches
117+
to the `gh-pages` branch within the originating repository.
118+
6. If you receive feedback, make changes using your issue-specific branches of the forked
119+
repository and the pull requests will update automatically.
120+
7. Repeat as needed until all feedback has been addressed.
121+
122+
When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
123+
before creating your own revision-specific branch(es) from there.
124+
Additionally, please only work from your newly-created branch(es) and *not*
125+
your clone of the originating `gh-pages` branch.
126+
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
127+
repository for reference while revising.
128+
129+
## Other Resources
130+
131+
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
132+
happens on the [discussion mailing list][discuss-list],
133+
which everyone is welcome to join.
134+
You can also [reach us by email][email].
135+
136+
[email]: mailto:[email protected]
137+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
138+
[dc-lessons]: http://datacarpentry.org/lessons/
139+
[dc-site]: http://datacarpentry.org/
140+
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
141+
[github]: https://github.com
142+
[github-flow]: https://guides.github.com/introduction/flow/
143+
[github-join]: https://github.com/join
144+
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
145+
[issues]: https://guides.github.com/features/issues/
146+
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
147+
[swc-lessons]: https://software-carpentry.org/lessons/
148+
[swc-site]: https://software-carpentry.org/

‎LICENSE.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: page
3+
title: "Licenses"
4+
root: .
5+
---
6+
## Instructional Material
7+
8+
All Software Carpentry and Data Carpentry instructional material is
9+
made available under the [Creative Commons Attribution
10+
license][cc-by-human]. The following is a human-readable summary of
11+
(and not a substitute for) the [full legal text of the CC BY 4.0
12+
license][cc-by-legal].
13+
14+
You are free:
15+
16+
* to **Share**---copy and redistribute the material in any medium or format
17+
* to **Adapt**---remix, transform, and build upon the material
18+
19+
for any purpose, even commercially.
20+
21+
The licensor cannot revoke these freedoms as long as you follow the
22+
license terms.
23+
24+
Under the following terms:
25+
26+
* **Attribution**---You must give appropriate credit (mentioning that
27+
your work is derived from work that is Copyright © Software
28+
Carpentry and, where practical, linking to
29+
http://software-carpentry.org/), provide a [link to the
30+
license][cc-by-human], and indicate if changes were made. You may do
31+
so in any reasonable manner, but not in any way that suggests the
32+
licensor endorses you or your use.
33+
34+
**No additional restrictions**---You may not apply legal terms or
35+
technological measures that legally restrict others from doing
36+
anything the license permits. With the understanding that:
37+
38+
Notices:
39+
40+
* You do not have to comply with the license for elements of the
41+
material in the public domain or where your use is permitted by an
42+
applicable exception or limitation.
43+
* No warranties are given. The license may not give you all of the
44+
permissions necessary for your intended use. For example, other
45+
rights such as publicity, privacy, or moral rights may limit how you
46+
use the material.
47+
48+
## Software
49+
50+
Except where otherwise noted, the example programs and other software
51+
provided by Software Carpentry and Data Carpentry are made available under the
52+
[OSI][osi]-approved
53+
[MIT license][mit-license].
54+
55+
Permission is hereby granted, free of charge, to any person obtaining
56+
a copy of this software and associated documentation files (the
57+
"Software"), to deal in the Software without restriction, including
58+
without limitation the rights to use, copy, modify, merge, publish,
59+
distribute, sublicense, and/or sell copies of the Software, and to
60+
permit persons to whom the Software is furnished to do so, subject to
61+
the following conditions:
62+
63+
The above copyright notice and this permission notice shall be
64+
included in all copies or substantial portions of the Software.
65+
66+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
67+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
68+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
69+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
70+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
71+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
72+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
73+
74+
## Trademark
75+
76+
"Software Carpentry" and "Data Carpentry" and their respective logos
77+
are registered trademarks of [Community Initiatives][CI].
78+
79+
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
80+
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
81+
[mit-license]: http://opensource.org/licenses/mit-license.html
82+
[ci]: http://communityin.org/
83+
[osi]: http://opensource.org

0 commit comments

Comments
 (0)