Skip to content

Commit 6bafb2d

Browse files
astroDimitriosastroDimitrios
committed
First commit
0 parents  commit 6bafb2d

31 files changed

+1604
-0
lines changed

‎.editorconfig

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
insert_final_newline = true
6+
trim_trailing_whitespace = true
7+
8+
[*.md]
9+
indent_size = 2
10+
indent_style = space
11+
max_line_length = 100 # Please keep this in sync with bin/lesson_check.py!
12+
trim_trailing_whitespace = false # keep trailing spaces in markdown - 2+ spaces are translated to a hard break (<br/>)
13+
14+
[*.r]
15+
max_line_length = 80
16+
17+
[*.py]
18+
indent_size = 4
19+
indent_style = space
20+
max_line_length = 79
21+
22+
[*.sh]
23+
end_of_line = lf
24+
25+
[Makefile]
26+
indent_style = tab

‎.gitignore

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# sandpaper files
2+
episodes/*html
3+
site/*
4+
!site/README.md
5+
6+
# History files
7+
.Rhistory
8+
.Rapp.history
9+
# Session Data files
10+
.RData
11+
# User-specific files
12+
.Ruserdata
13+
# Example code in package build process
14+
*-Ex.R
15+
# Output files from R CMD build
16+
/*.tar.gz
17+
# Output files from R CMD check
18+
/*.Rcheck/
19+
# RStudio files
20+
.Rproj.user/
21+
# produced vignettes
22+
vignettes/*.html
23+
vignettes/*.pdf
24+
# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
25+
.httr-oauth
26+
# knitr and R markdown default cache directories
27+
*_cache/
28+
/cache/
29+
# Temporary files created by R markdown
30+
*.utf8.md
31+
*.knit.md
32+
# R Environment Variables
33+
.Renviron
34+
# pkgdown site
35+
docs/
36+
# translation temp files
37+
po/*~
38+
# renv detritus
39+
renv/sandbox/
40+
*.pyc
41+
*~
42+
.DS_Store
43+
.ipynb_checkpoints
44+
.sass-cache
45+
.jekyll-cache/
46+
.jekyll-metadata
47+
__pycache__
48+
_site
49+
.Rproj.user
50+
.bundle/
51+
.vendor/
52+
vendor/
53+
.docker-vendor/
54+
Gemfile.lock
55+
.*history

‎.mailmap

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Abigail Cabunoc Mayes <[email protected]>
2+
Abigail Cabunoc Mayes <[email protected]> <[email protected]>
3+
Alois Heilmaier <[email protected]>
4+
Andrew Lonsdale <[email protected]>
5+
Andrew Rohl <[email protected]>
6+
Ariel Rokem <[email protected]>
7+
Arnstein Orten <[email protected]>
8+
Bennet Fauber <[email protected]>
9+
Bérénice Batut <[email protected]>
10+
Bérénice Batut <[email protected]> <[email protected]>
11+
Bernhard Konrad <[email protected]>
12+
Bill Mills <[email protected]>
13+
Brenna O'Brien <[email protected]>
14+
Chris Pawsey <[email protected]>
15+
Christoph Junghans <[email protected]> <[email protected]>
16+
Daisie Huang <[email protected]>
17+
Danielle Traphagen <[email protected]>
18+
Dorota Jarecka <[email protected]>
19+
Emily Dolson <[email protected]>
20+
Emmanouil Farsarakis <[email protected]> <[email protected]>
21+
Erin Becker <[email protected]>
22+
Evan P. Williamson <[email protected]>
23+
François Michonneau <[email protected]>
24+
Greg Watson <[email protected]>
25+
Greg Wilson <[email protected]> <[email protected]>
26+
Ivan Gonzalez <[email protected]> <[email protected]>
27+
James Allen <[email protected]> <[email protected]>
28+
Jane Charlesworth <[email protected]>
29+
Kate Lee <[email protected]>
30+
Luke W. Johnston <[email protected]>
31+
Marisa Guarinello <[email protected]>
32+
Mark Wheelhouse <[email protected]>
33+
Mary C. Kinniburgh <[email protected]>
34+
Mateusz Kuzak <[email protected]>
35+
Matthias Haeni <[email protected]>
36+
Maxim Belkin <[email protected]> <[email protected]>
37+
Michael Panitz <[email protected]>
38+
Mike Jackson <[email protected]> <[email protected]>
39+
Nicholas Hannah <[email protected]> <[email protected]>
40+
Nicola Soranzo <[email protected]> <[email protected]>
41+
Patrick C. Shriwise <[email protected]>
42+
Pauline Barmby <[email protected]>
43+
Peter Steinbach <[email protected]> <[email protected]>
44+
Raniere Silva <[email protected]> <[email protected]>
45+
Raniere Silva <[email protected]> <[email protected]>
46+
Rémi Emonet <[email protected]> <[email protected]>
47+
Rémi Emonet <[email protected]> <[email protected]>
48+
Sarah Stevens <[email protected]> <[email protected]>
49+
Sean Aubin <[email protected]>
50+
Steve Vandervalk <[email protected]> <[email protected]>
51+
Tiffany Timbers <[email protected]>
52+
Timothée Poisot <[email protected]> <[email protected]>
53+
Tom Kelly <[email protected]>
54+
Vijay P. Nagraj <[email protected]>
55+
Yuandra Ismiraldi <[email protected]>
56+
zz-abracarambar <[email protected]>

‎.update-copyright.conf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[project]
2+
vcs: Git
3+
4+
[files]
5+
authors: yes
6+
files: no

‎AUTHORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Dimitrios Theodorakis
2+
Emma Hogan

‎CODE_OF_CONDUCT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Contributor Code of Conduct"
3+
---
4+
5+
As contributors and maintainers of this project,
6+
we pledge to follow the [The Carpentries Code of Conduct][coc].
7+
8+
Instances of abusive, harassing, or otherwise unacceptable behavior
9+
may be reported by following our [reporting guidelines][coc-reporting].
10+
11+
12+
[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
13+
[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html

‎CONTRIBUTING.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
## Contributing
2+
3+
[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data
4+
Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source
5+
projects, and we welcome contributions of all kinds: new lessons, fixes to
6+
existing material, bug reports, and reviews of proposed changes are all
7+
welcome.
8+
9+
### Contributor Agreement
10+
11+
By contributing, you agree that we may redistribute your work under [our
12+
license](LICENSE.md). In exchange, we will address your issues and/or assess
13+
your change proposal as promptly as we can, and help you become a member of our
14+
community. Everyone involved in [The Carpentries][cp-site] agrees to abide by
15+
our [code of conduct](CODE_OF_CONDUCT.md).
16+
17+
### How to Contribute
18+
19+
The easiest way to get started is to file an issue to tell us about a spelling
20+
mistake, some awkward wording, or a factual error. This is a good way to
21+
introduce yourself and to meet some of our community members.
22+
23+
1. If you do not have a [GitHub][github] account, you can [send us comments by
24+
email][contact]. However, we will be able to respond more quickly if you use
25+
one of the other methods described below.
26+
27+
2. If you have a [GitHub][github] account, or are willing to [create
28+
one][github-join], but do not know how to use Git, you can report problems
29+
or suggest improvements by [creating an issue][repo-issues]. This allows us
30+
to assign the item to someone and to respond to it in a threaded discussion.
31+
32+
3. If you are comfortable with Git, and would like to add or change material,
33+
you can submit a pull request (PR). Instructions for doing this are
34+
[included below](#using-github). For inspiration about changes that need to
35+
be made, check out the [list of open issues][issues] across the Carpentries.
36+
37+
Note: if you want to build the website locally, please refer to [The Workbench
38+
documentation][template-doc].
39+
40+
### Where to Contribute
41+
42+
1. If you wish to change this lesson, add issues and pull requests here.
43+
2. If you wish to change the template used for workshop websites, please refer
44+
to [The Workbench documentation][template-doc].
45+
46+
47+
### What to Contribute
48+
49+
There are many ways to contribute, from writing new exercises and improving
50+
existing ones to updating or filling in the documentation and submitting [bug
51+
reports][issues] about things that do not work, are not clear, or are missing.
52+
If you are looking for ideas, please see [the list of issues for this
53+
repository][repo-issues], or the issues for [Data Carpentry][dc-issues],
54+
[Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
55+
56+
Comments on issues and reviews of pull requests are just as welcome: we are
57+
smarter together than we are on our own. **Reviews from novices and newcomers
58+
are particularly valuable**: it's easy for people who have been using these
59+
lessons for a while to forget how impenetrable some of this material can be, so
60+
fresh eyes are always welcome.
61+
62+
### What *Not* to Contribute
63+
64+
Our lessons already contain more material than we can cover in a typical
65+
workshop, so we are usually *not* looking for more concepts or tools to add to
66+
them. As a rule, if you want to introduce a new idea, you must (a) estimate how
67+
long it will take to teach and (b) explain what you would take out to make room
68+
for it. The first encourages contributors to be honest about requirements; the
69+
second, to think hard about priorities.
70+
71+
We are also not looking for exercises or other material that only run on one
72+
platform. Our workshops typically contain a mixture of Windows, macOS, and
73+
Linux users; in order to be usable, our lessons must run equally well on all
74+
three.
75+
76+
### Using GitHub
77+
78+
If you choose to contribute via GitHub, you may want to look at [How to
79+
Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
80+
use [GitHub flow][github-flow] to manage changes:
81+
82+
1. Create a new branch in your desktop copy of this repository for each
83+
significant change.
84+
2. Commit the change in that branch.
85+
3. Push that branch to your fork of this repository on GitHub.
86+
4. Submit a pull request from that branch to the [upstream repository][repo].
87+
5. If you receive feedback, make changes on your desktop and push to your
88+
branch on GitHub: the pull request will update automatically.
89+
90+
NB: The published copy of the lesson is usually in the `main` branch.
91+
92+
Each lesson has a team of maintainers who review issues and pull requests or
93+
encourage others to do so. The maintainers are community volunteers, and have
94+
final say over what gets merged into the lesson.
95+
96+
### Other Resources
97+
98+
The Carpentries is a global organisation with volunteers and learners all over
99+
the world. We share values of inclusivity and a passion for sharing knowledge,
100+
teaching and learning. There are several ways to connect with The Carpentries
101+
community listed at <https://carpentries.org/connect/> including via social
102+
media, slack, newsletters, and email lists. You can also [reach us by
103+
email][contact].
104+
105+
[repo]: https://github.com/swcarpentry/git-novice
106+
[repo-issues]: https://github.com/swcarpentry/git-novice/issues
107+
[contact]: mailto:[email protected]
108+
[cp-site]: https://carpentries.org/
109+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
110+
[dc-lessons]: https://datacarpentry.org/lessons/
111+
[dc-site]: https://datacarpentry.org/
112+
[discuss-list]: https://lists.software-carpentry.org/listinfo/discuss
113+
[github]: https://github.com
114+
[github-flow]: https://guides.github.com/introduction/flow/
115+
[github-join]: https://github.com/join
116+
[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
117+
[issues]: https://carpentries.org/help-wanted-issues/
118+
[lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
119+
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
120+
[swc-lessons]: https://software-carpentry.org/lessons/
121+
[swc-site]: https://software-carpentry.org/
122+
[lc-site]: https://librarycarpentry.org/
123+
[template-doc]: https://carpentries.github.io/workbench/

‎LICENSE.md

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

‎README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://slack-invite.carpentries.org/)
2+
[![Slack Status](https://img.shields.io/badge/Slack_Channel-swc--git-E01563.svg)](https://carpentries.slack.com/messages/C91JS49HD)
3+
4+
# git-working-practices
5+
6+
An introduction to working practices using Git and GitHub.
7+
Please see [https://www.astropython.com/git-working-practices/](https://www.astropython.com/git-working-practices/) for a rendered version of this material,
8+
or [the lesson template documentation][lesson-example] for instructions on formatting, building, and submitting material.
9+
10+
Maintainers:
11+
12+
Dimitrios Theodorakis, [[email protected]](mailto:[email protected])
13+
Emma Hogan, [[email protected]](mailto:[email protected])
14+
15+
[lesson-example]: https://carpentries.github.io/sandpaper-docs/

0 commit comments

Comments
 (0)