Verified Commit 44f39602 authored by Toby Hodges's avatar Toby Hodges Committed by Renato Alves
Browse files

Update CONTRIBUTING.md

parent bf827502
# Contributing # Contributing
[The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source projects, This lesson is an open source project,
and we welcome contributions of all kinds: and we welcome contributions of all kinds:
new lessons, new episodes,
fixes to existing material, fixes to existing material,
bug reports, bug reports,
and reviews of proposed changes are all welcome. and reviews of proposed changes are all welcome.
...@@ -14,8 +14,6 @@ you agree that we may redistribute your work under [our license](LICENSE.md). ...@@ -14,8 +14,6 @@ you agree that we may redistribute your work under [our license](LICENSE.md).
In exchange, In exchange,
we will address your issues and/or assess your change proposal as promptly as we can, 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. 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 ## How to Contribute
...@@ -26,43 +24,11 @@ or a factual error. ...@@ -26,43 +24,11 @@ or a factual error.
This is a good way to introduce yourself This is a good way to introduce yourself
and to meet some of our community members. 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 ## Where to Contribute
1. If you wish to change this lesson, If you wish to change this lesson,
please work in <https://github.com/swcarpentry/python-novice-inflammation>, please work in <https://git.embl.de/grp-bio-it-workshops/intermediate-python/>,
which can be viewed at <https://swcarpentry.github.io/python-novice-inflammation>. which can be viewed at <https://grp-bio-it-workshops.embl-community.io/intermediate-python/>.
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 ## What to Contribute
...@@ -72,9 +38,7 @@ to updating or filling in the documentation ...@@ -72,9 +38,7 @@ to updating or filling in the documentation
and submitting [bug reports][issues] and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing. about things that don't work, aren't clear, or are missing.
If you are looking for ideas, please see the 'Issues' tab for If you are looking for ideas, please see the 'Issues' tab for
a list of issues associated with this repository, 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: Comments on issues and reviews of pull requests are just as welcome:
we are smarter together than we are on our own. we are smarter together than we are on our own.
...@@ -83,10 +47,6 @@ it's easy for people who have been using these lessons for a while ...@@ -83,10 +47,6 @@ it's easy for people who have been using these lessons for a while
to forget how impenetrable some of this material can be, to forget how impenetrable some of this material can be,
so fresh eyes are always welcome. 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, As a rule,
if you want to introduce a new idea, if you want to introduce a new idea,
you must (a) estimate how long it will take to teach you must (a) estimate how long it will take to teach
...@@ -99,40 +59,33 @@ Our workshops typically contain a mixture of Windows, macOS, and Linux users; ...@@ -99,40 +59,33 @@ Our workshops typically contain a mixture of Windows, macOS, and Linux users;
in order to be usable, in order to be usable,
our lessons must run equally well on all three. our lessons must run equally well on all three.
## Using GitHub ## Using GitLab
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]. 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. 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. The maintainers have final say over what gets merged into the lesson.
To use the web interface for contributing to a lesson: To use the web interface for contributing to a lesson:
1. Fork the originating repository to your GitHub profile. 1. Fork the originating repository to your EMBL GitLab profile
2. Within your version of the forked repository, move to the `gh-pages` branch and (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
create a new branch for each significant change being made. 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. 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. 4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches 5. Create individual merge requests from each of your changed branches
to the `gh-pages` branch within the originating repository. to the `master` branch within the originating repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked 6. If you receive feedback, make changes using your issue-specific branches of the forked
repository and the pull requests will update automatically. repository and the pull requests will update automatically.
7. Repeat as needed until all feedback has been addressed. 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 When starting work, please make sure your clone of the originating `master` branch is up-to-date
before creating your own revision-specific branch(es) from there. before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and *not* Additionally, please only work from your newly-created branch(es) and *not*
your clone of the originating `gh-pages` branch. your clone of the originating `master` branch.
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating Lastly, published copies of all the lessons are available in the `master` branch of the originating
repository for reference while revising. 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:admin@software-carpentry.org [email]: mailto:admin@software-carpentry.org
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[dc-lessons]: http://datacarpentry.org/lessons/ [dc-lessons]: http://datacarpentry.org/lessons/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment