Commit 079d7d50 authored by Greg Wilson's avatar Greg Wilson
Browse files

Updating contribution guidelines in boilerplate

parent 519cd35b
Loading
Loading
Loading
Loading
+23 −18
Original line number Diff line number Diff line
@@ -61,7 +61,24 @@ and to meet some of our community members.
    you can submit a pull request (PR).
    Instructions for doing this are [included below](#using-github).

## What We're Looking For
## Where to Contribute

1.  If you wish to change this example lesson,
    please work in <https://github.com/swcarpentry/lesson-example>.
    This lesson documents the format of our lessons,
    and can be viewed at <https://swcarpentry.github.io/lesson-example>.

2.  If you wish to change the template used for workshop websites,
    please work in <https://github.com/swcarpentry/workshop-template>.
    The home page of that repository explains how to set up workshop websites,
    while the extra pages in <https://swcarpentry.github.io/workshop-template>
    provide more background on our design choices.

3.  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/swcarpentry/styles>.

## What to Contribute

There are many ways to contribute,
from writing new exercises and improving existing ones
@@ -80,7 +97,7 @@ 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.

## What We're *Not* Looking For
## 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.
@@ -96,16 +113,9 @@ 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
## Using GitHub

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.

If you want to start adding or fixing material yourself,
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].
In brief:
@@ -132,11 +142,6 @@ or encourage others to do so.
The maintainers are community volunteers,
and have final say over what gets merged into the lesson.

## Our Template

[This documentation][example-site] explains how we format our lessons
(and is itself an example of that formatting).

## Other Resources

General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
@@ -154,8 +159,8 @@ You can also [reach us by email][contact].
[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/{USERNAME}/{LESSON-NAME}/issues/
[repo]: https://github.com/{USERNAME}/{LESSON-NAME}/
[issues]: https://github.com/swcarpentry/lesson-example/issues/
[repo]: https://github.com/swcarpentry/lesson-example/
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: http://software-carpentry.org/lessons/
[swc-site]: http://software-carpentry.org/