Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 2.07 KB
Raw

Contributing

First of all, great that you're considering to contribute. Anything that you can contribute is highly appreciated! 👍🎉

This documented is inspired by the carpentries contributing file.

This project is open source and we welcome contributions of all kinds, but mostly by:

  • adding course material
  • typos

Contributor Agreement

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, end 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 course material you would like to add, 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.

Through an issue

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.

Through a pull request

If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). If you are contributing through a PR make sure to adhere to some formatting rules.

A course in the list has the following format:

- [**ORGANIZATIION** COURSE TITLE](LINK TO REPO) | [website](LINK TO WEBSITE)

For the carpentries shell novice course this would be:

- [**Carpentries** The Unix Shell](https://github.com/swcarpentry/shell-novice) | [website](https://swcarpentry.github.io/shell-novice/)

All courses are in a markdown list, so make sure you start with -.

Try to add courses to existing topics as much as possible. If you add a new topic, the index should be updated automatically through the CI.