diff --git a/bin/boilerplate/README.md b/bin/boilerplate/README.md index 43a6b7225e5de62ac66451d8b5628fb9f50bf369..22a3f79ac96de55ae08267fc0e365e405ac20d56 100644 --- a/bin/boilerplate/README.md +++ b/bin/boilerplate/README.md @@ -2,7 +2,7 @@ [![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/) -FIXME +This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons. ## Contributing @@ -13,9 +13,21 @@ We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTR the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even how to write new episodes. +Please see the current list of [issues][] for ideas for contributing to this +repository. For making your contribution, we use the GitHub flow, which is +nicely explained in the chapter [Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git +by Scott Chacon. +Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-yellowgreen.svg). This indicates that the mantainers will welcome a pull request fixing this issue. + + ## Maintainer(s) -* FIXME +Current maintainers of this lesson are + +* +* +* + ## Authors