Add pull request template with checklist for submitting a tutorial

inbo / tutorials

A collection of technical tutorials for INBO (and anyone who's interested)

https://inbo.github.io/tutorials/

Creative Commons Attribution 4.0 International

22 stars 9 forks source link

Add pull request template with checklist for submitting a tutorial #104

Closed ThierryO closed 3 years ago

ThierryO commented 5 years ago

The create tutorial is quite long. A TL;DR section should summarise the key requirements for the tutorials. It can assume that the reader knows about git, github, Rstudio, ... If they don't than they can read the full document.

peterdesmet commented 5 years ago

For info on PR templates, see https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository. Create it as .github/pull_request_template.md

peterdesmet commented 5 years ago

From #103, also mention:

Another, maybe more easy to setup, option is to describe in the PR template to the user to have a check [on included post categories]

peterdesmet commented 5 years ago

@ThierryO can you give the first go for this PR tutorial submission checklist? I can review it.

peterdesmet commented 5 years ago

Or rather, the first person from @inbo/oscibio @inbo/bmk that submits a tutorial can start listing things on this checklist.