Skip to content
CONTRIBUTING.md 1.83 KiB
Newer Older
Greg Wilson's avatar
Greg Wilson committed
Software Carpentry is an open source project,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
and reviews of proposed changes are all equally welcome.

By contributing,
you are agreeing that Software Carpentry may redistribute your work under
[these licenses][license].
Greg Wilson's avatar
Greg Wilson committed

## Getting Started

1.  We use GitHub flow to manage changes,
    which is explained in the chapter [Contributing to a Project][pro-git-chapter]
Greg Wilson's avatar
Greg Wilson committed
    in Scott Chacon's book *Pro Git*.

2.  For our lessons,
    you should branch from and submit pull requests against the `gh-pages` branch.
Greg Wilson's avatar
Greg Wilson committed

3.  When editing lesson pages, you need only commit changes to the Markdown source files.

4.  If you're looking for things to work on,
    please see [the list of issues for this repository][lesson-template-issues],
    or for [our other lessons][swc-lessons].
Greg Wilson's avatar
Greg Wilson committed
    Comments on issues and reviews of pull requests are equally welcome.
Greg Wilson's avatar
Greg Wilson committed

## Other Resources

1.  This lesson is based on the template found at
    [https://github.com/swcarpentry/lesson-template](https://github.com/swcarpentry/lesson-template).
    That repository has instructions on formatting and previewing lessons.

2.  For a list of helpful commands run `make` in this directory.

3.  The [list of maintainers][swc-maintainers]
    on the [Software Carpentry website][swc-website]
Greg Wilson's avatar
Greg Wilson committed
    lists the people currently responsible for managing this repository.
    Feel free to contact them if you have any questions or languishing pull requests.

[lesson-template-issues]: https://github.com/swcarpentry/lesson-template/issues
Raniere Silva's avatar
Raniere Silva committed
[license]: LICENSE.md
[pro-git]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
[swc-lessons]: http://software-carpentry.org/lessons.html
[swc-maintainers]: http://software-carpentry.org/lessons.html#maintainers
[swc-website]: http://software-carpentry.org