GitHub Actions: cache required R packages (#534)

[rnaseq-cwl-training.git] / bin / boilerplate / README.md

diff --git a/bin/boilerplate/README.md b/bin/boilerplate/README.md
index dbf5ea3e47b67b13bb0a0024538bc1653ce4f347..060994aef38102e7f2b4fdf7196e76ffa9b5dd29 100644 (file)
--- 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][FIXME] 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-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue.  
+
+
 ## Maintainer(s)
 
+Current maintainers of this lesson are 
+
 * FIXME
+* FIXME
+* FIXME
+
 
 ## Authors
 
@@ -25,4 +37,4 @@ A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
 
 To cite this lesson, please consult with [CITATION](CITATION)
 
-[lesson-example]: https://swcarpentry.github.io/lesson-example
\ No newline at end of file
+[lesson-example]: https://carpentries.github.io/lesson-example