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

'initial' contribution #13

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
root = true

[*]
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
indent_size = 2
indent_style = space
max_line_length = 100 # Please keep this in sync with bin/lesson_check.py!

[*.r]
max_line_length = 80

[*.py]
indent_size = 4
indent_style = space
max_line_length = 79

[*.sh]
end_of_line = lf

[Makefile]
indent_style = tab
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Please delete this line and 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.

If this issue is about a specific episode within a lesson, please provide its link or filename.

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 The Carpentries Team at [email protected].

---
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 this line and 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 The Carpentries Team at [email protected].

---
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*.pyc
*~
.DS_Store
.ipynb_checkpoints
.sass-cache
.jekyll-cache/
__pycache__
_site
.Rproj.user
.Rhistory
.RData
.idea
2 changes: 2 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/python-intermediate.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 61 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Abigail Cabunoc Mayes <[email protected]>
Abigail Cabunoc Mayes <[email protected]> <[email protected]>
Andy Kwong <[email protected]>
Ardita Shkurti <[email protected]>
Ariel Rokem <[email protected]>
Arron Shiffer <[email protected]>
Bartosz Telenczuk <[email protected]>
Brian Stucky <[email protected]>
Damien Irving <[email protected]> <[email protected]>
Derek Howard <[email protected]>
Devendra Umbrajkar <[email protected]>
Edwin van der Helm <[email protected]> <[email protected]>
Erin Becker <[email protected]>
Evan P. Williamson <[email protected]>
Ewan Barr <[email protected]>
François Michonneau <[email protected]>
Giovanni Torres <[email protected]>
Greg Wilson <[email protected]> <[email protected]>
Ian Carroll <[email protected]> <[email protected]>
James Adams <[email protected]>
James Allen <[email protected]> <[email protected]>
Jean-Christophe Leyder <[email protected]> <[email protected]>
Jessica Upani <[email protected]>
Jim Stapleton <[email protected]>
Jin Choi <[email protected]>
John Chase <[email protected]>
John R. Leeman <[email protected]>
Katie Moore <[email protected]>
Kristoffer L. Nielbo <[email protected]>
Leigh Sheneman <[email protected]>
Mahdi Sadjadi <[email protected]>
Maxim Belkin <[email protected]> <[email protected]>
Maxime Boissonneault <[email protected]>
Mike Jackson <[email protected]> <[email protected]>
Narayanan Raghupathy <[email protected]>
Neal Davis <[email protected]> <[email protected]>
Nicola Soranzo <[email protected]> <[email protected]>
Nicola Soranzo <[email protected]> <[email protected]>
Pauline Barmby <[email protected]>
Pawel Pomorski <[email protected]>
Peter Cock <[email protected]>
Pey-Lian Lim <[email protected]>
Raffaella Demichelis <[email protected]>
Raniere Silva <[email protected]> <[email protected]>
Raniere Silva <[email protected]> <[email protected]>
Rémi Emonet <[email protected]> <[email protected]>
Rémi Emonet <[email protected]> <[email protected]>
Richard Clare <[email protected]>
Roald Eiselen <[email protected]>
Ryan Dale <[email protected]>
Ryan Neufeld <[email protected]> <[email protected]>
Sarah Clayton <[email protected]>
Sigrid Klerke <[email protected]>
Timothée Poisot <[email protected]> <[email protected]>
Toby Hodges <[email protected]>
Valentina Staneva <[email protected]>
Valentina Staneva <[email protected]> <[email protected]>
Vinai Roopchansingh <[email protected]>
Willem Ligtenberg <[email protected]>
zz-msleigh <[email protected]>
zz-YourName <[email protected]>
18 changes: 18 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
language: python
python:
- "3.6"
# Remember that the code is running on a 14.04 machine.
# - "3.4"
# command to install dependencies
install:
- pip install -r requirements.txt
# as per https://docs.travis-ci.com/user/installing-dependencies/
# command to run tests
before_script:
- "python bin/_travis.py"
script:
- python bin/workshop_check.py .
- python -m unittest bin/_test/bs4test.py
branches:
only:
- gh-pages
6 changes: 6 additions & 0 deletions .update-copyright.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[project]
vcs: Git

[files]
authors: yes
files: no
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Maximilian Dolling
6 changes: 6 additions & 0 deletions CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Please cite as:

Azalee Bostroem, Trevor Bekolay, and Valentina Staneva (eds):
"Software Carpentry: Programming with Python." Version 2016.06, June
2016, https://github.com/swcarpentry/python-novice-inflammation,
10.5281/zenodo.57492.
Comment on lines +3 to +6
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure you

  • Adapted the Citation

11 changes: 11 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: page
title: "Contributor Code of Conduct"
---
As contributors and maintainers of this project,
we pledge to follow the [Carpentry Code of Conduct][coc].

Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by following our [reporting guidelines][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

[The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-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 [The Carpentries][c-site]
agrees to abide by our [code of conduct](CODE_OF_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/python-intermediate>,
which can be viewed at <https://swcarpentry.github.io/python-intermediate>.

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

3. If you wish to change the template used for workshop websites,
please work in <https://github.com/carpentries/workshop-template>.
The home page of that repository explains how to set up workshop websites,
while the extra pages in <https://carpentries.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/carpentries/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 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 'Issues' tab for
a list of issues associated with this repository,
or you may also look at the issues for [Data Carpentry][dc-issues],
[Software Carpentry][swc-issues], and [Library Carpentry][lc-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, macOS, 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].
To manage changes, we follow [GitHub flow][github-flow].
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.
To use the web interface for contributing to a lesson:

1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch and
create a new branch for each significant change being made.
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches
to the `gh-pages` branch within the originating repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked
repository and the pull requests will update automatically.
7. Repeat as needed until all feedback has been addressed.

When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and *not*
your clone of the originating `gh-pages` branch.
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
repository for reference while revising.

## 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:[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]: 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://guides.github.com/features/issues/
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: https://software-carpentry.org/lessons/
[swc-site]: https://software-carpentry.org/
[c-site]: https://carpentries.org/
[lc-site]: https://librarycarpentry.org/
[lc-issues]: https://github.com/issues?q=user%3Alibrarycarpentry
10 changes: 10 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

source 'https://rubygems.org'

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

# Synchronize with https://pages.github.com/versions
ruby '>=2.5.3'

gem 'github-pages', group: :jekyll_plugins
Loading