-
Notifications
You must be signed in to change notification settings - Fork 524
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from swcarpentry/gh-pages
updating my copy
- Loading branch information
Showing
122 changed files
with
5,947 additions
and
16,356 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 [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. | ||
|
||
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]). | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 [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. | ||
|
||
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]). | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,7 @@ | ||
*~ | ||
*.pyc | ||
*~ | ||
.DS_Store | ||
.ipynb_checkpoints | ||
.sass-cache | ||
__pycache__ | ||
_site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
Aron Ahmadia | ||
Phillip Alderman | ||
James Allen | ||
Piotr Banaszkiewicz | ||
Pauline Barmby | ||
Radovan Bast | ||
John Blischak | ||
Olga Botvinnik | ||
Andy Boughton | ||
Erik M. Bray | ||
Amy Brown | ||
C. Titus Brown | ||
Greg Caporaso | ||
Sarah Clayton | ||
Matt Davis | ||
Neal Davis | ||
Jonah Duckles | ||
Marianna Foos | ||
Yashasvi Girdhar | ||
Ivan Gonzalez | ||
John Gosset | ||
Alistair Grant | ||
Thomas Guignard | ||
Konrad Hinsen | ||
Xavier Ho | ||
Damien Irving | ||
Mike Jackson | ||
Ben Jolly | ||
Jan T. Kim | ||
W. Trevor King | ||
David LeBauer | ||
Joona Lehtomäki | ||
Kunal Marwaha | ||
Sheldon McKay | ||
Lauren Michael | ||
François Michonneau | ||
Lex Nederbragt | ||
Aleksandra Nenadic | ||
Jeramia Ory | ||
Fernando Perez | ||
Leighton Pritchard | ||
Andrey Prokopenko | ||
Scott Ritchie | ||
Maneesha Sane | ||
Raniere Silva | ||
Arfon Smith | ||
Ashwin Srinath | ||
Sarah Stevens | ||
Julia Stewart Lowndes | ||
Tracy Teal | ||
Stefan Topfstedt | ||
Olav Vahtras | ||
Philipp Von Bieberstein | ||
Andrew Walker | ||
Ben Waugh | ||
Lukas Weber | ||
Ethan White | ||
Jason Williams | ||
Carol Willing | ||
Greg Wilson | ||
Tom Wright | ||
Andrea Zonca | ||
Alex Thompson | ||
Jonathan Cooper | ||
Marcel Stimberg | ||
Mark A. Matienzo | ||
Steve Moss |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Please cite as: | ||
|
||
Greg Wilson (ed): "Software Carpentry: Workshop Template." Version | ||
2016.06, June 2016, https://github.com/swcarpentry/workshop-template, | ||
10.5281/zenodo.58156. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,45 @@ | ||
# Contributor Code of Conduct | ||
--- | ||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
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 this Code of Conduct. 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]. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/). | ||
- [Software and Data Carpentry Code of Conduct][coc] | ||
- [Code of Conduct Reporting Guide][coc-reporting] | ||
|
||
{% include links.md %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,142 @@ | ||
# How to Contribute | ||
# Contributing | ||
|
||
Software Carpentry is an open source project, | ||
[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 equally welcome. | ||
and reviews of proposed changes are all welcome. | ||
|
||
## Contributor Agreement | ||
|
||
By contributing, | ||
you are agreeing that Software Carpentry may redistribute your work under | ||
[these licenses][license]. | ||
You also agree to abide by our | ||
[contributor code of conduct][conduct]. | ||
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][contact]. | ||
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 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. | ||
|
||
2. 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: | ||
|
||
## Getting Started | ||
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. | ||
|
||
1. We use GitHub flow to manage changes, | ||
which is explained in the chapter [Contributing to a Project][pro-git-chapter] | ||
in Scott Chacon's book *Pro Git*. | ||
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. | ||
|
||
2. You should branch from and submit pull requests against the `gh-pages` branch of this repository. | ||
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 | ||
|
||
This lesson is based on the template found at | ||
[https://github.com/swcarpentry/workshop-template][workshop-template]. | ||
That repository has instructions on formatting and previewing workshop websites. | ||
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][contact]. | ||
|
||
[conduct]: CONDUCT.md | ||
[license]: LICENSE.md | ||
[pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project | ||
[workshop-template]: https://github.com/swcarpentry/workshop-template | ||
[contact]: mailto:[email protected] | ||
[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]: http://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/workshop-template/issues/ | ||
[repo]: https://github.com/swcarpentry/workshop-template/ | ||
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry | ||
[swc-lessons]: http://software-carpentry.org/lessons/ | ||
[swc-site]: http://software-carpentry.org/ |
Oops, something went wrong.