CONTRIBUTING.md 5.83 KB
Newer Older
Greg Wilson's avatar
Greg Wilson committed
1
# Contributing
Greg Wilson's avatar
Greg Wilson committed
2

Greg Wilson's avatar
Greg Wilson committed
3
[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
Greg Wilson's avatar
Greg Wilson committed
4
5
6
7
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
Greg Wilson's avatar
Greg Wilson committed
8
9
10
and reviews of proposed changes are all welcome.

## Contributor Agreement
Greg Wilson's avatar
Greg Wilson committed
11
12

By contributing,
Greg Wilson's avatar
Greg Wilson committed
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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).

Greg Wilson's avatar
Greg Wilson committed
46
47
## Where to Contribute

48
1.  If you wish to change the template used for workshop websites,
Greg Wilson's avatar
Greg Wilson committed
49
    please work in <https://github.com/swcarpentry/workshop-template>.
Greg Wilson's avatar
Greg Wilson committed
50
    The home page of that repository explains how to set up workshop websites,
Greg Wilson's avatar
Greg Wilson committed
51
    while the extra pages in <https://swcarpentry.github.io/workshop-template>
Greg Wilson's avatar
Greg Wilson committed
52
53
    provide more background on our design choices.

54
2.  If you wish to change CSS style files, tools,
Greg Wilson's avatar
Greg Wilson committed
55
    or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
Greg Wilson's avatar
Greg Wilson committed
56
    please work in <https://github.com/swcarpentry/styles>.
Greg Wilson's avatar
Greg Wilson committed
57
58

## What to Contribute
Greg Wilson's avatar
Greg Wilson committed
59
60
61
62

There are many ways to contribute,
from writing new exercises and improving existing ones
to updating or filling in the documentation
Adam Hughes's avatar
Adam Hughes committed
63
and submitting [bug reports][issues]
Greg Wilson's avatar
Greg Wilson committed
64
65
66
67
68
69
70
71
72
73
74
75
76
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.

Greg Wilson's avatar
Greg Wilson committed
77
## What *Not* to Contribute
Greg Wilson's avatar
Greg Wilson committed
78
79
80
81
82
83
84
85
86
87
88

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.
Katrin Leinweber's avatar
Katrin Leinweber committed
89
Our workshops typically contain a mixture of Windows, macOS, and Linux users;
Greg Wilson's avatar
Greg Wilson committed
90
91
in order to be usable,
our lessons must run equally well on all three.
Greg Wilson's avatar
Greg Wilson committed
92

Greg Wilson's avatar
Greg Wilson committed
93
## Using GitHub
Greg Wilson's avatar
Greg Wilson committed
94

Greg Wilson's avatar
Greg Wilson committed
95
If you choose to contribute via GitHub,
Greg Wilson's avatar
Greg Wilson committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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.

Greg Wilson's avatar
Greg Wilson committed
122
123
## Other Resources

Greg Wilson's avatar
Greg Wilson committed
124
125
126
127
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].
Greg Wilson's avatar
Greg Wilson committed
128

Greg Wilson's avatar
Greg Wilson committed
129
130
131
132
133
134
135
136
137
[contact]: 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]: 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
138
139
[issues]: https://github.com/swcarpentry/workshop-template/issues/
[repo]: https://github.com/swcarpentry/workshop-template/
Greg Wilson's avatar
Greg Wilson committed
140
141
142
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: http://software-carpentry.org/lessons/
[swc-site]: http://software-carpentry.org/