CONTRIBUTING.md 4.43 KB
Newer Older
1
2
# Contributing

Toby Hodges's avatar
Toby Hodges committed
3
This lesson is an open source project,
4
and we welcome contributions of all kinds:
Toby Hodges's avatar
Toby Hodges committed
5
new episodes,
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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.

## 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.

## Where to Contribute

Toby Hodges's avatar
Toby Hodges committed
29
30
31
If you wish to change this lesson,
please work in <https://git.embl.de/grp-bio-it-workshops/intermediate-python/>,
which can be viewed at <https://grp-bio-it-workshops.embl-community.io/intermediate-python/>.
32
33
34
35
36
37
38
39
40

## 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
Toby Hodges's avatar
Toby Hodges committed
41
a list of issues associated with this repository.
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

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.

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.

Toby Hodges's avatar
Toby Hodges committed
62
## Using GitLab
63
64
65

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.
Toby Hodges's avatar
Toby Hodges committed
66
The maintainers have final say over what gets merged into the lesson.
67
68
To use the web interface for contributing to a lesson:

Toby Hodges's avatar
Toby Hodges committed
69
70
71
72
1.  Fork the originating repository to your EMBL GitLab profile 
  (external contributors should contact the lesson maintainers 
  to obtain an external account).
2.  Within your version of the forked repository, move to the `master` branch and
73
create a new branch for each significant change being made.
74
75
3.  Navigate to the file(s) you wish to change within the new branches and make
revisions as required.
76
4.  Commit all changed files within the appropriate branches.
Toby Hodges's avatar
Toby Hodges committed
77
78
5.  Create individual merge requests from each of your changed branches
to the `master` branch within the originating repository.
79
80
81
82
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.

Toby Hodges's avatar
Toby Hodges committed
83
When starting work, please make sure your clone of the originating `master` branch is up-to-date
84
85
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and *not*
Toby Hodges's avatar
Toby Hodges committed
86
87
your clone of the originating `master` branch.
Lastly, published copies of all the lessons are available in the `master` branch of the originating
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
repository for reference while revising.

[email]: 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]: 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