From 7ac6e645f05976234bc48a35ec832add09ce6fab Mon Sep 17 00:00:00 2001 From: Rayna M Harris Date: Fri, 23 Mar 2018 16:23:35 -0300 Subject: [PATCH 1/2] Update 03-organization.md added blurb about templates in the .github directory. Text copied from https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/ --- _episodes/03-organization.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_episodes/03-organization.md b/_episodes/03-organization.md index 74b8683f..a78f6a3f 100644 --- a/_episodes/03-organization.md +++ b/_episodes/03-organization.md @@ -163,6 +163,9 @@ The `bin/lesson_initialize.py` script creates files that need to be customized f 2. Its title must be `"Instructors' Guide"`. 3. Its permalink must be `/guide/`. 4. It may include whatever content the author thinks appropriate. + +`.github/ISSUE_TEMPLATE.md` and `.github/PULL_REQUEST_TEMPLATE.md` +: When you add an issue and/or pull request templates to your repository, project contributors will automatically see the template's contents in the issue or pull request body. Templates customize and standardize the information you'd like included when contributors contribute. These files can also be stored in `docs` instead of `.github`. ## Figures From 7dcc3028af3c5de9108e546cb37bba1c8119eccb Mon Sep 17 00:00:00 2001 From: Rayna M Harris Date: Wed, 11 Apr 2018 14:15:10 -0300 Subject: [PATCH 2/2] Update 03-organization.md - moved templates to an "optional" section - added a link to two example templates --- _episodes/03-organization.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_episodes/03-organization.md b/_episodes/03-organization.md index a78f6a3f..39453202 100644 --- a/_episodes/03-organization.md +++ b/_episodes/03-organization.md @@ -164,8 +164,10 @@ The `bin/lesson_initialize.py` script creates files that need to be customized f 3. Its permalink must be `/guide/`. 4. It may include whatever content the author thinks appropriate. +# Optional Files Files + `.github/ISSUE_TEMPLATE.md` and `.github/PULL_REQUEST_TEMPLATE.md` -: When you add an issue and/or pull request templates to your repository, project contributors will automatically see the template's contents in the issue or pull request body. Templates customize and standardize the information you'd like included when contributors contribute. These files can also be stored in `docs` instead of `.github`. +: When you add an issue and/or pull request templates to your repository, project contributors will automatically see the template's contents in the issue or pull request body. Templates customize and standardize the information you'd like included when contributors contribute. These files can also be stored in `docs` instead of `.github`. Here are two example templates for a issues ([1](https://github.com/swcarpentry/r-novice-gapminder/blob/gh-pages/.github/ISSUE_TEMPLATE.md),[2](https://github.com/carpentries/2018-04-bug-bbq/blob/master/.github/ISSUE_TEMPLATE/local-event.md)). ## Figures