Update 03-organization.md #188
Conversation
added blurb about templates in the .github directory. Text copied from https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
|
The information is in the wrong section.
isn't the right place because https://github.com/swcarpentry/lesson-example/blob/gh-pages/bin/lesson_initialize.py doesn't create the files. |
|
Thanks, @rgaiacs. I didn't realize that they were all tied to the .py script. Would these be considered 'helper files'? Or maybe there could be a new section called 'Additional files' or 'Optional files'? |
+1 for either. |
- moved templates to an "optional" section - added a link to two example templates
|
Thanks @rgaiacs. I went with "optional files" |
_episodes/03-organization.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
This need to be a <h2> so please use ##.
_episodes/03-organization.md
Outdated
| `.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)). |
There was a problem hiding this comment.
Examples need to be linked to this repository and not a third party one.
There was a problem hiding this comment.
Hmmm. Okay, let me think about that for a moment.
Updated lesson_initialize
added blurb about templates in the
.githubdirectory. Text copied from https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/