The Sydney Informatics Hub welcomes your comments, fixes and suggestions to improve our training courses! Using the platform and templates developed by The Carpentries, you can easily fork out GitHub repos and make edits.
Software Carpentry and Data Carpentry are open source projects, and they welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.
By contributing, you agree that we may redistribute your work under our license. 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.
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 do not have a GitHub account, you can send us comments by email. However, we will be able to respond more quickly if you use one of the other methods described below.
If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion.
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.
If you wish to change this lesson, please work in https://github.com/Sydney-Informatics-Hub/training.gadi.intro, which can be viewed at https://sydney-informatics-hub.github.io/training.gadi.intro.
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.
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.
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.
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 about things that don’t work, aren’t clear, or are missing.
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.
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. 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.
If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub. To manage changes, we follow GitHub flow. 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. To use the web interface for contributing to a lesson:
gh-pages branch and
create a new branch for each significant change being made.gh-pages branch within the originating repository.When starting work, please make sure your clone of the originating gh-pages branch is up-to-date
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and not
your clone of the originating gh-pages branch.
Lastly, published copies of all the lessons are available in the gh-pages branch of the originating
repository for reference while revising.
Get in touch with us by email! Be sure to have a look at our training site. And come say hi next Hacky Hour!
General discussion of Software Carpentry and Data Carpentry happens on their discussion mailing list, which everyone is welcome to join. You can also reach them by email.