Data Carpentry is an open source project, and we welcome contributions of all kinds: new and improved lessons, bug reports, and small fixes to existing material are all useful.
By contributing, you are agreeing that Data Carpentry may redistribute your work under these licenses.
Table of Contents
-
Fork the
datacarpentry/sql-ecologyrepository on GitHub. -
Clone that repository to your own machine.
-
Create a branch from
gh-pagesfor your changes. Give your branch a meaningful name, such asfix-typos-in-select-queryoradd-groupby. -
Make your changes, commit them, and push them to your repository on GitHub.
-
Send a pull request to the
gh-pagesbranch of the repository
If it is easier for you to send them to us some other way, please mail us at [email protected]. Given a choice between you creating content or wrestling with Git, we'd rather have you doing the former.
Every lesson has its own repository, with individual files for each topic. We use two digits followed by a one-word topic key to ensure files appear in the right order when listed.
Lessons should be written in Markdown.
We don't store data for lessons inside the lesson repositories. For completed lessons the data should be publicly available in a data repository appropriate to the data type. For lesson development the data may be provided in any way that is convenient including posting to a website, on figshare, a public dropbox link, a GitHub gist, or even included in the PR. Once the PR is ready to merge the data should be placed in the official data repository and all links to the data updated.
To ensure a consistent formatting of the lessons, we recommend the following guidelines:
- No trailing white space
- Wrap lines at 80 characters (unless it breaks URLs)
- Use unclosed
#symbols for headers, e.g.# Heading 1
- Where can I get help?
Open an issue or email the Discuss list at [email protected]