Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bringing in Carpentries lesson template #35

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
355 commits
Select commit Hold shift + click to select a range
ec38fb6
fix footer for small displays
fmichonneau Feb 23, 2015
843999c
Merge pull request #10 from pbanaszkiewicz/fix-table-styles
Feb 25, 2015
e8b726e
Merge pull request #12 from fmichonneau/site-update
fmichonneau Mar 2, 2015
49ff04f
Fix background for lessons
Mar 21, 2015
5c28510
Add Bootstrap theme
pbanaszkiewicz Feb 18, 2015
32544f5
Fix: styles for panel heading
pbanaszkiewicz Feb 18, 2015
1289f51
Merge pull request #16 from r-gaia-cs/styles-fix-background
Mar 21, 2015
d576934
Merge pull request #17 from r-gaia-cs/style-panels
Mar 21, 2015
f8bd46e
Add documentation about card class
Mar 21, 2015
caa88ff
Merge pull request #18 from r-gaia-cs/styles-card
Mar 21, 2015
d299916
consolidate badge classes to swc.css
fmichonneau Mar 24, 2015
37d4bcf
Bootstrap v3.3.4
Apr 19, 2015
0c3058b
Improve figures
Apr 19, 2015
e752fad
CSS compatible with different versions of Pandoc
Apr 19, 2015
0d08b98
Fix path of fonts
Apr 19, 2015
a3b5731
Merge pull request #24 from fmichonneau/merge-badge-classes
Apr 25, 2015
bb6f0f2
Merge branch 'upgrade-bootstrap' into new-style
Apr 25, 2015
b42f539
Merge branch 'style-img-responsive' into new-style
Apr 25, 2015
381ddab
Merge branch 'styles-compatible' into new-style
Apr 25, 2015
8cc34be
fix #26: updated bundled deck.js, including the fix on browsercast
twitwi May 1, 2015
d085366
Merge pull request #30 from twitwi/master
May 2, 2015
6e037a5
CSS cataloguing tool
gvwilson Jun 14, 2015
15331a0
Fixing typo
gvwilson Jun 14, 2015
9c447b8
Preparing for June 2016 release
gvwilson Jun 20, 2016
600e4a3
Tidying up based on first contact with R maintainers.
gvwilson Jun 21, 2016
11b78e9
Making nav bar responsive
gvwilson Jun 21, 2016
19beaaf
add tools to deal with episodes written in Rmd
fmichonneau Jun 21, 2016
3de9486
Merge pull request #56 from fmichonneau/rmarkdown-tools
Jun 21, 2016
32f32d3
Removing legacy PHONY target lesson-single
gvwilson Jun 22, 2016
ea2a2ee
Directory for R Markdown files
gvwilson Jun 22, 2016
9bfebc4
use .r instead of .source for code chunks
fmichonneau Jun 22, 2016
ff37db0
remove extra line return in knitr output
fmichonneau Jun 22, 2016
1044395
Merge pull request #61 from fmichonneau/fix-rmd-formatting
Jun 22, 2016
a733e2a
Raising exception instead of printing error on bad YAML
gvwilson Jun 22, 2016
2a53ed7
Making line-length checking optional for lessons.
gvwilson Jun 22, 2016
3c28d16
Checking that episodes are numbered consecutively
gvwilson Jun 22, 2016
fc98097
Printing error messages in sorted order
gvwilson Jun 22, 2016
0c9c153
Checking metadata fields more carefully
gvwilson Jun 22, 2016
4e8365b
use anonymous function to generate markdown files
fmichonneau Jun 22, 2016
02b4ec1
Merge pull request #62 from fmichonneau/fix-knitr-env
fmichonneau Jun 22, 2016
8667603
Better display of file groups in Makefile
gvwilson Jun 23, 2016
08d224a
Only try building R files if there are some
gvwilson Jun 23, 2016
1dcf9fc
Switching to site.root and site.repo
gvwilson Jun 23, 2016
7c21775
Updating _config_dev.yml to match changes to root and repo vars
gvwilson Jun 23, 2016
2e8a6b0
Merge branch '2016-06' into building-r
gvwilson Jun 23, 2016
05c8b44
Changing text of auto-generated file
gvwilson Jun 23, 2016
c565218
Merge pull request #64 from gvwilson/building-r
Jun 24, 2016
41a7763
move data/ into _episodes/ and _episodes_rmd/
fmichonneau Jun 24, 2016
5217736
Only cleaning intermediate R files on demand.
gvwilson Jun 25, 2016
519cd35
Checking for non-Markdown files.
gvwilson Jun 25, 2016
ac67ebc
Converting workshop checker to use Reporter class.
gvwilson Jun 26, 2016
805c05e
Checking CONTRIBUTING.md (without YAML)
gvwilson Jun 26, 2016
046dfbd
Adding error handling for YAML import.
gvwilson Jun 26, 2016
c3a1639
Markdownifying questions, keypoints, etc.
gvwilson Jun 26, 2016
e0f4c7a
Styling workshops correctly.
gvwilson Jun 26, 2016
de59b96
Making pages work for workshops as well as lessons
gvwilson Jun 26, 2016
4c788a5
Merge pull request #67 from gvwilson/clean-rmd
fmichonneau Jun 27, 2016
079d7d5
Updating contribution guidelines in boilerplate
gvwilson Jun 27, 2016
40dbc70
Merge branch '2016-06' of github.com:swcarpentry/styles into 2016-06
gvwilson Jun 27, 2016
ae6d6f6
Merge branch 'converting-to-reporter' into 2016-06
gvwilson Jun 27, 2016
4a0ac26
Merge branch 'markdownify' into 2016-06
gvwilson Jun 27, 2016
8237ab5
Merge branch 'styling-workshops' into 2016-06
gvwilson Jun 27, 2016
993bac7
simplify to single _episodes_rmd/data folder
fmichonneau Jun 28, 2016
ea8797f
re-add ./data folder
fmichonneau Jun 28, 2016
acb49f7
Merge branch 'move-data' of https://github.com/fmichonneau/styles int…
gvwilson Jun 28, 2016
c2f89a7
Checking ends of lines
gvwilson Jun 30, 2016
634e055
add function knitr_fig_path
fmichonneau Jul 1, 2016
fb17830
Lesson checking parameter handling
gvwilson Jul 1, 2016
06c8f26
Merge pull request #73 from fmichonneau/knitr_fig_path
Jul 2, 2016
030ac5c
Looking for missing or superfluous images
gvwilson Jul 2, 2016
570451a
Merge branch '2016-06' of github.com:swcarpentry/styles into 2016-06
gvwilson Jul 2, 2016
2b419e3
Images cannot be wider than the page
gvwilson Jul 3, 2016
68bf4bb
Checking for .nojekyll file
gvwilson Jul 3, 2016
503cddd
Must provide permalinks in pages, not layouts
gvwilson Jul 3, 2016
9610f40
Checking more configuration values
gvwilson Jul 6, 2016
9a5ab18
Starting on tool to check repository settings.
gvwilson Jul 7, 2016
e577ea8
Checking for links to figures
gvwilson Jul 7, 2016
9d6512c
Tighter checks for figures
gvwilson Jul 7, 2016
5520175
Handling anchors by ignoring them
gvwilson Jul 8, 2016
466c28d
Adding support for MATLAB
gvwilson Jul 8, 2016
cf51440
Making the code a little more robust
gvwilson Jul 13, 2016
8748a80
Switching to GitHub-defined variables
gvwilson Jul 14, 2016
2d3d5dd
Lesson initializer
gvwilson Jul 14, 2016
a56ac2d
Synchronizing lesson checker with late changes
gvwilson Jul 14, 2016
9de64a0
Cleaning up prev/next logic
gvwilson Jul 14, 2016
a4ec693
Using 00:00 as a start time
gvwilson Jul 15, 2016
aee474a
Always checking upstream
gvwilson Jul 15, 2016
14cce03
Cleaning up sorting of error messages.
gvwilson Jul 15, 2016
148bfcc
Ignoring a few more things
gvwilson Jul 18, 2016
9341f9b
check packages required and install them if needed
fmichonneau Jul 20, 2016
45729b5
simplify code checking for knitr
fmichonneau Jul 20, 2016
a19a625
Forcing CSS and Javascript to be loaded via HTTPS.
gvwilson Jul 21, 2016
c1fe9d8
Loading standard images via HTTPS
gvwilson Jul 21, 2016
d02d8a7
Merge pull request #83 from fmichonneau/check-r-packages
Jul 21, 2016
f3b921a
Import future print in case of python2 environment
gdevenyi Jul 21, 2016
5f116cd
Merge pull request #85 from gdevenyi/gh-pages
Jul 21, 2016
aa316f8
Moving from __future__ to start of file
gvwilson Jul 21, 2016
9be4b22
Checking future print
gvwilson Jul 21, 2016
cebd855
Checking that internally-defined links resolve.
gvwilson Jul 24, 2016
ec16457
Updating the lesson initializer's CONTRIBUTING.md
gvwilson Jul 26, 2016
0607fcf
Adding a few more URLs
gvwilson Jul 28, 2016
cf5d417
To help with debugging
gvwilson Jul 30, 2016
fb06bdb
Fix "br" typo causing ugly rendering (epub only)
twitwi Aug 25, 2016
4f08a69
Merge pull request #92 from swcarpentry/twitwi-patch-1
Aug 26, 2016
791dcc3
Switch to relative: use page.root in most templates
twitwi Sep 5, 2016
62b5dbc
Switch to relative: in episode_title, use page.root + rewrite
twitwi Sep 5, 2016
a688650
Switch to relative: setup default root and specific root for index.md
twitwi Sep 5, 2016
cf15546
Navigation links in footer
gvwilson Sep 5, 2016
e12c3a4
Adding footnote about syllabus
gvwilson Sep 7, 2016
00a16f7
Changing name of instructor's guide to 'instructor notes'
gvwilson Sep 7, 2016
7da36a5
Adding ID attribute to schedule
gvwilson Sep 7, 2016
a366bcc
Displaying break information in a box
gvwilson Sep 12, 2016
68c1493
Removing trailing space in Ruby file
gvwilson Sep 12, 2016
f0a9475
Adding checks for things that commonly go wrong during template conve…
gvwilson Sep 15, 2016
94ef967
accessibility fixes.
evanwill Sep 23, 2016
fcce315
fix search meta tag.
evanwill Sep 23, 2016
20ef8e2
Merge pull request #104 from evanwill/search-fix
rgaiacs Sep 23, 2016
9788e51
Merge pull request #103 from evanwill/accessibility-fix
rgaiacs Sep 23, 2016
284a94b
Adding Google Analytics code
gvwilson Sep 26, 2016
7f8e13d
Merge pull request #105 from gvwilson/analytics
jduckles Sep 26, 2016
94ab587
Adding link to training survey to config
gvwilson Oct 5, 2016
0a8b55c
Starting to incorporate Library Carpentry materials
gvwilson Oct 7, 2016
7afa83e
Fixing typo in license file
gvwilson Oct 7, 2016
37a3a11
Merge pull request #107 from gvwilson/training-survey
Oct 7, 2016
d0b3cf4
Merge branch 'gh-pages' into adding-jquery-debugging
gvwilson Oct 7, 2016
9fde967
Contact address
gvwilson Oct 7, 2016
177d441
Adding link to citation
gvwilson Oct 7, 2016
3293c26
Tidying up references to LC
gvwilson Oct 7, 2016
2acc4f2
Updating lesson checker to include Library Carpentry values
gvwilson Oct 8, 2016
4b90bb3
Add link to setup from schedule
rgaiacs Oct 18, 2016
60900b8
Merge pull request #110 from rgaiacs/setup
rgaiacs Oct 31, 2016
da1e5db
Merge branch 'gh-pages' into library-carpentry
gvwilson Nov 8, 2016
cfac061
Web site for Library Carpentry
gvwilson Nov 8, 2016
4030b74
Merge pull request #108 from gvwilson/library-carpentry
Nov 8, 2016
43c4108
lesson.scss: 2em left padding for lists
maxim-belkin Dec 14, 2016
ad4c372
Visually separate inline code blocks
maxim-belkin Dec 14, 2016
8fb905e
changes lesson-rmd target to lesson-md with new recipe
Dec 31, 2016
c8f6fdc
Merge pull request #116 from maxim-belkin/patch-1
rgaiacs Jan 9, 2017
61ad44f
Using page.previous and page.next for links instead of loop
gvwilson Jan 9, 2017
b357f4e
Adding comments on include files purposes
gvwilson Jan 9, 2017
d5f879a
Including mention of Library Carpentry in include files
gvwilson Jan 9, 2017
f5d8968
Merge pull request #121 from gvwilson/prev-next
rgaiacs Jan 9, 2017
3d96a51
Merge pull request #122 from gvwilson/commenting-includes
rgaiacs Jan 9, 2017
d62084b
Merge pull request #119 from itcarroll/gh-pages
rgaiacs Jan 9, 2017
a4ab656
Merging changes from other branches
gvwilson Jan 10, 2017
5e89d32
Merge pull request #123 from gvwilson/mentioning-library-carpentry
rgaiacs Jan 10, 2017
d271051
Checking consolidated links
gvwilson Jan 15, 2017
cfc5573
Addition of link to setup had one too few columns.
gvwilson Jan 18, 2017
4dcf2ed
Add missing class on _includes/syllabus.html
rgaiacs Jan 18, 2017
9781de1
Add multiday condition on _includes/syllabus.html
rgaiacs Jan 18, 2017
3a09799
Enforce Bootstrap's 12 column layout
rgaiacs Jan 18, 2017
0958c5f
bin/lesson_initialize.py: Remove 'example-site' reference
wking Jan 23, 2017
3d04cbb
Merge pull request #128 from wking/example-site-reference
rgaiacs Jan 24, 2017
39973ee
ensure dt elements have an id set
neon-ninja Jan 31, 2017
0cb3ca5
Add javascript comments to the dt-ids snippet
neon-ninja Jan 31, 2017
220eedc
Merge pull request #126 from gvwilson/consolidating-links
rgaiacs Feb 4, 2017
48248d1
Merge pull request #117 from maxim-belkin/patch-2
rgaiacs Feb 8, 2017
0bbff2b
Merge pull request #109 from gvwilson/adding-jquery-debugging
rgaiacs Feb 18, 2017
62e0431
Merge pull request #127 from rgaiacs/fix-syllabus
rgaiacs Feb 18, 2017
93aae56
Merge pull request #129 from neon-ninja/dt-ids
rgaiacs Feb 18, 2017
c510f14
Make tables wider
rgaiacs Feb 18, 2017
bb66b28
Merge pull request #132 from rgaiacs/table
rgaiacs Feb 18, 2017
60185ce
Improve round corners on block input and output
rgaiacs Feb 18, 2017
5ec7776
Merge pull request #133 from rgaiacs/styles-round-corners
rgaiacs Feb 18, 2017
9911100
Update copyright year with current year
rgaiacs Mar 2, 2017
89b2d3c
Merge pull request #135 from rgaiacs/106
rgaiacs Mar 2, 2017
8dbb992
Add link to Edit on GitHub
rgaiacs Feb 23, 2017
2093505
Change Edit on GitHub link to edit page
rgaiacs Mar 3, 2017
8874a3f
Adopt @lexnederbragt suggestion for Edit link
rgaiacs Mar 3, 2017
15da8bb
Fix issue with link to GitHub from RMarkdown files
rgaiacs Mar 3, 2017
6731202
Merge pull request #136 from rgaiacs/styles-edit-on-github
rgaiacs Mar 3, 2017
c0eafd4
Numbering the lessons in the schedule
rgaiacs Feb 18, 2017
d68646c
Merge pull request #137 from rgaiacs/styles-numbering
rgaiacs Mar 3, 2017
f994dfb
Revert "ensure dt elements have an id set"
rgaiacs Mar 3, 2017
bb2b611
Merge pull request #138 from swcarpentry/revert-129-dt-ids
rgaiacs Mar 3, 2017
12506a4
Improve wording on syllabus.html
rgaiacs Mar 14, 2017
50d94bd
Merge pull request #139 from rgaiacs/improve-wording
rgaiacs Mar 14, 2017
38307ff
Add Library Carpentry to the workshop template
rgaiacs Apr 4, 2017
bc6056f
Suggest template language
ErinBecker Apr 25, 2017
db363c8
fix swcarpentry/lesson-examples#118: use checkpoint::scanForPackages
fmichonneau Apr 29, 2017
df9ba82
Merge pull request #145 from fmichonneau/fix-checkpoint
rgaiacs May 2, 2017
53c0a7f
make sure that checkpoint version is 0.4.0 or higher
fmichonneau May 4, 2017
468a433
Merge pull request #146 from fmichonneau/check-version-checkpoint
rgaiacs May 5, 2017
ac2d0d5
Merge pull request #142 from rgaiacs/styles-library-carpentry
rgaiacs May 6, 2017
895499e
Merge pull request #143 from ErinBecker/gh-pages
rgaiacs May 6, 2017
7999654
Updated CONDUCT.md
rgaiacs May 6, 2017
e4e394b
Merge pull request #147 from rgaiacs/update-coc
rgaiacs May 6, 2017
6f6cba4
Make challenges and discussion visibles
rgaiacs May 6, 2017
6951d40
Merge pull request #148 from rgaiacs/show-challenges
rgaiacs May 6, 2017
3474a5f
Add all in one lesson build with Javascript
rgaiacs May 2, 2017
908fff1
Merge pull request #149 from rgaiacs/styles-print
rgaiacs May 6, 2017
c34c225
Remove extra link to Library Carpentry
rgaiacs May 6, 2017
1e56203
Remove CONDUCT.md since it should be generate by bin/lesson_initializ…
rgaiacs May 6, 2017
98e4bc6
Fix bug with Python script
rgaiacs May 6, 2017
9f34e6e
Revert "Remove CONDUCT.md since it should be generate by bin/lesson_i…
rgaiacs May 10, 2017
b08b83d
Handler for collaborative_notes
rgaiacs Jun 18, 2017
55c2e1b
Link LC as for SWC and DC
jnothman Jul 4, 2017
8462459
Merge pull request #156 from jnothman/patch-1
rgaiacs Jul 4, 2017
6e4e4c4
Unify Library Carpentry logo
rgaiacs Jul 5, 2017
8fed5dc
Merge pull request #157 from rgaiacs/155
rgaiacs Jul 5, 2017
0ab311b
Fix logo at navbar
rgaiacs Jul 5, 2017
1a6efba
Merge pull request #158 from rgaiacs/fix-logo-nav
rgaiacs Jul 5, 2017
4b831ad
Add Library Carpentry SVG logo
rgaiacs Jul 6, 2017
879e415
Update Library Carpentry logo
rgaiacs Jul 14, 2017
ba59492
Merge pull request #159 from rgaiacs/lc-svg-logo
rgaiacs Jul 14, 2017
eb1bb0a
Sort episodes before producing figures
mawds Aug 8, 2017
2208a4b
Sort HTML_DST output
mawds Aug 8, 2017
354a469
Merge pull request #163 from mawds/sortfigs
rgaiacs Aug 8, 2017
b2abd06
add keyboard key style
brandoncurtis Aug 18, 2017
1df4f12
use <kbd></kbd> for keyboard keys
brandoncurtis Aug 28, 2017
961d4ee
Load methods package
jsta Sep 5, 2017
745e85d
Merge pull request #169 from jsta/patch-1
rgaiacs Sep 6, 2017
d20077a
Converted to `col-xs-*` from `col-md-*` classes for navbar div
IanLee1521 Oct 11, 2017
b54dcce
Pull left / right arrows in episode nav to outside of row
IanLee1521 Oct 11, 2017
5edc669
Merge pull request #174 from IanLee1521/fix-episode-nav-wrapping
rgaiacs Oct 11, 2017
5aaa87a
Add "Offline" Capable
rgaiacs Nov 5, 2017
a7be704
Merge pull request #181 from rgaiacs/styles-offline
rgaiacs Nov 5, 2017
17a345a
Fix github-importer link
rgaiacs Nov 5, 2017
080298e
Merge pull request #182 from rgaiacs/gh-pages
rgaiacs Nov 5, 2017
9fd880c
Fix concept-maps link
rgaiacs Nov 5, 2017
3418441
Merge pull request #183 from rgaiacs/gh-pages
rgaiacs Nov 5, 2017
337a6e8
Merge pull request #165 from brandoncurtis/keyboard-keys
rgaiacs Nov 5, 2017
47bfe1b
Replace extract_figures.py with Javacript
rgaiacs Nov 5, 2017
1082c28
Merge pull request #184 from rgaiacs/styles-js-load-images
rgaiacs Nov 5, 2017
76c2d51
Adopt email instead of contact as keyword
rgaiacs Nov 5, 2017
446d1c2
Merge pull request #185 from rgaiacs/178
rgaiacs Nov 5, 2017
3e332fc
Fix email as keyword in bin/lesson_check.py
rgaiacs Nov 5, 2017
95644a9
Fix root YAML variable in bin/lesson_initialize.py
rgaiacs Nov 7, 2017
595602d
Fix broken link
rgaiacs Nov 15, 2017
78d3716
Enable syntax highlighting
naught101 Nov 16, 2017
1b10e59
Change bin/chunk-options.R to use .language-r instead of r
rgaiacs Nov 16, 2017
a747be0
Fix validation for syntax highlight
rgaiacs Nov 16, 2017
7e835fd
Remove check for all_figures.html now that we are using Javascript
rgaiacs Nov 16, 2017
1083d36
Merge pull request #192 from rgaiacs/syntax-highlight
rgaiacs Nov 16, 2017
9259abf
Fix usage instruction at bin/workshop_check.py
rgaiacs Nov 19, 2017
e1a840c
Rename _includes/lc/syllabys.html to _includes/lc/syllabus.html
rgaiacs Nov 19, 2017
fcc731b
Port changes from workshop
rgaiacs Nov 23, 2017
b68e55d
Port changes from workshop
rgaiacs Nov 23, 2017
23a9827
Copy _extras/figures.md from lesson example
rgaiacs Nov 23, 2017
a1ab182
Fix bin/lesson_initialize.py
rgaiacs Nov 24, 2017
01957e2
Merge pull request #193 from rgaiacs/gh-pages
rgaiacs Nov 24, 2017
0f8afa2
Fix problem with {% link reference.md %}
rgaiacs Dec 1, 2017
4f40bac
pre-empt server-side redirects
katrinleinweber Dec 20, 2017
0e1523e
Merge pull request #196 from katrinleinweber/patch-1
rgaiacs Dec 21, 2017
18991c3
moved markdown files temporarily to bring in template
tracykteal Dec 31, 2017
6f16138
Merge remote-tracking branch 'template/gh-pages' into gh-pages
tracykteal Dec 31, 2017
6c24c70
added template
tracykteal Dec 31, 2017
0541a3f
moved episode files to proper place
tracykteal Dec 31, 2017
c0e46e6
removed template intro episode
tracykteal Dec 31, 2017
8dde7e5
yaml formatting in 02
tracykteal Dec 31, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Please delete the text below before submitting your contribution.

---

Thanks for contributing! If this contribution is for instructor training, please send an email to checkout@carpentries.org 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.

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 (k8hertweck@gmail.com).

---
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Please delete the text below before submitting your contribution.

---

Thanks for contributing! If this contribution is for instructor training, please send an email to checkout@carpentries.org 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.

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 (k8hertweck@gmail.com).

---
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.pyc
*~
.DS_Store
.ipynb_checkpoints
.sass-cache
__pycache__
_site
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
FIXME: list authors' names and email addresses.
1 change: 1 addition & 0 deletions CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
FIXME: describe how to cite this lesson.
45 changes: 45 additions & 0 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: page
title: "Contributor Code of Conduct"
permalink: /conduct/
---
As contributors and maintainers of this project,
we pledge to respect all people who contribute through reporting issues,
posting feature requests,
updating documentation,
submitting pull requests or patches,
and other activities.

We are committed to making participation in this project a harassment-free experience for everyone,
regardless of level of experience,
gender,
gender identity and expression,
sexual orientation,
disability,
personal appearance,
body size,
race,
ethnicity,
age,
or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery,
derogatory comments or personal attacks,
trolling,
public or private harassment,
insults,
or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to our [Code of Conduct][coc].
Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by following our [reporting guidelines][coc-reporting].


- [Software and Data Carpentry Code of Conduct][coc]
- [Code of Conduct Reporting Guide][coc-reporting]

{% include links.md %}
151 changes: 151 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# Contributing

[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
and reviews of proposed changes are all welcome.

## Contributor Agreement

By contributing,
you agree that we may redistribute your work under [our license](LICENSE.md).
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 [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
agrees to abide by our [code of conduct](CONDUCT.md).

## How to Contribute

The easiest way to get started is to file an issue
to tell us about a spelling mistake,
some awkward wording,
or a factual error.
This is a good way to introduce yourself
and to meet some of our community members.

1. If you do not have a [GitHub][github] account,
you can [send us comments by email][email].
However,
we will be able to respond more quickly if you use one of the other methods described below.

2. If you have a [GitHub][github] account,
or are willing to [create one][github-join],
but do not know how to use Git,
you can report problems or suggest improvements by [creating an issue][issues].
This allows us to assign the item to someone
and to respond to it in a threaded discussion.

3. If you are comfortable with Git,
and would like to add or change material,
you can submit a pull request (PR).
Instructions for doing this are [included below](#using-github).

## Where to Contribute

1. If you wish to change this lesson,
please work in <https://github.com/swcarpentry/FIXME>,
which can be viewed at <https://swcarpentry.github.io/FIXME>.

2. If you wish to change the example lesson,
please work in <https://github.com/swcarpentry/lesson-example>,
which documents the format of our lessons
and can be viewed at <https://swcarpentry.github.io/lesson-example>.

3. If you wish to change the template used for workshop websites,
please work in <https://github.com/swcarpentry/workshop-template>.
The home page of that repository explains how to set up workshop websites,
while the extra pages in <https://swcarpentry.github.io/workshop-template>
provide more background on our design choices.

4. If you wish to change CSS style files, tools,
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
please work in <https://github.com/swcarpentry/styles>.

## What to Contribute

There are many ways to contribute,
from writing new exercises and improving existing ones
to updating or filling in the documentation
and and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing.
If you are looking for ideas,
please see [the list of issues for this repository][issues],
or the issues for [Data Carpentry][dc-issues]
and [Software Carpentry][swc-issues] projects.

Comments on issues and reviews of pull requests are just as welcome:
we are smarter together than we are on our own.
Reviews from novices and newcomers are particularly valuable:
it's easy for people who have been using these lessons for a while
to forget how impenetrable some of this material can be,
so fresh eyes are always welcome.

## What *Not* to Contribute

Our lessons already contain more material than we can cover in a typical workshop,
so we are usually *not* looking for more concepts or tools to add to them.
As a rule,
if you want to introduce a new idea,
you must (a) estimate how long it will take to teach
and (b) explain what you would take out to make room for it.
The first encourages contributors to be honest about requirements;
the second, to think hard about priorities.

We are also not looking for exercises or other material that only run on one platform.
Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
in order to be usable,
our lessons must run equally well on all three.

## Using GitHub

If you choose to contribute via GitHub,
you may want to look at
[How to Contribute to an Open Source Project on GitHub][how-contribute].
In brief:

1. The published copy of the lesson is in the `gh-pages` branch of the repository
(so that GitHub will regenerate it automatically).
Please create all branches from that,
and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
before starting work.
Please do *not* work directly in your `gh-pages` branch,
since that will make it difficult for you to work on other contributions.

2. We use [GitHub flow][github-flow] to manage changes:
1. Create a new branch in your desktop copy of this repository for each significant change.
2. Commit the change in that branch.
3. Push that branch to your fork of this repository on GitHub.
4. Submit a pull request from that branch to the [master repository][repo].
5. If you receive feedback,
make changes on your desktop and push to your branch on GitHub:
the pull request will update automatically.

Each lesson has two maintainers who review issues and pull requests
or encourage others to do so.
The maintainers are community volunteers,
and have final say over what gets merged into the lesson.

## Other Resources

General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
happens on the [discussion mailing list][discuss-list],
which everyone is welcome to join.
You can also [reach us by email][email].

[email]: mailto:admin@software-carpentry.org
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[dc-lessons]: http://datacarpentry.org/lessons/
[dc-site]: http://datacarpentry.org/
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[issues]: https://github.com/swcarpentry/FIXME/issues/
[repo]: https://github.com/swcarpentry/FIXME/
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: https://software-carpentry.org/lessons/
[swc-site]: https://software-carpentry.org/
83 changes: 83 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
layout: page
title: "Licenses"
root: .
---
## Instructional Material

All Software Carpentry and Data Carpentry instructional material is
made available under the [Creative Commons Attribution
license][cc-by-human]. The following is a human-readable summary of
(and not a substitute for) the [full legal text of the CC BY 4.0
license][cc-by-legal].

You are free:

* to **Share**---copy and redistribute the material in any medium or format
* to **Adapt**---remix, transform, and build upon the material

for any purpose, even commercially.

The licensor cannot revoke these freedoms as long as you follow the
license terms.

Under the following terms:

* **Attribution**---You must give appropriate credit (mentioning that
your work is derived from work that is Copyright © Software
Carpentry and, where practical, linking to
http://software-carpentry.org/), provide a [link to the
license][cc-by-human], and indicate if changes were made. You may do
so in any reasonable manner, but not in any way that suggests the
licensor endorses you or your use.

**No additional restrictions**---You may not apply legal terms or
technological measures that legally restrict others from doing
anything the license permits. With the understanding that:

Notices:

* You do not have to comply with the license for elements of the
material in the public domain or where your use is permitted by an
applicable exception or limitation.
* No warranties are given. The license may not give you all of the
permissions necessary for your intended use. For example, other
rights such as publicity, privacy, or moral rights may limit how you
use the material.

## Software

Except where otherwise noted, the example programs and other software
provided by Software Carpentry and Data Carpentry are made available under the
[OSI][osi]-approved
[MIT license][mit-license].

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## Trademark

"Software Carpentry" and "Data Carpentry" and their respective logos
are registered trademarks of [NumFOCUS][numfocus].

[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
[mit-license]: https://opensource.org/licenses/mit-license.html
[numfocus]: https://numfocus.org/
[osi]: https://opensource.org
Loading