-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moving some material around to make contribution easier
- Loading branch information
Showing
4 changed files
with
56 additions
and
35 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 |
---|---|---|
|
@@ -5,7 +5,10 @@ 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 agree that we may redistribute your work under [our license](LICENSE.md). | ||
In exchange, | ||
|
@@ -15,6 +18,32 @@ 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](mailto:{{ site.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). | ||
|
||
## What We're Looking For | ||
|
||
There are many ways to contribute, | ||
|
@@ -40,8 +69,8 @@ Our lessons already contain more material than we can cover in a typical worksho | |
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. | ||
you must estimate how long it will take to teach | ||
and 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. | ||
|
||
|
@@ -50,14 +79,7 @@ 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. | ||
|
||
## Getting Started | ||
|
||
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. | ||
## Using GitHub | ||
|
||
If you want to start adding or fixing material yourself, | ||
you may want to look at | ||
|
@@ -96,15 +118,16 @@ and have final say over what gets merged into the lesson. | |
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]. | ||
You can also [reach us by email][mailto:{{ site.email }}]. | ||
|
||
[contact]: [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/mailman/listinfo/discuss_lists.software-carpentry.org | ||
[example-site]: https://gvwilson.github.io/new-lesson-example/ | ||
[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/gvwilson/new-lesson-example/issues/ | ||
[repo]: https://github.com/gvwilson/new-lesson-example/ | ||
|
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
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