From bc81ab097ec8657a72776333d3b4122dbb23b673 Mon Sep 17 00:00:00 2001 From: Christoph Schlosser Date: Sat, 16 Dec 2017 21:28:46 +0100 Subject: Add issue and PR template --- .github/ISSUE_TEMPLATE.md | 25 +++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..9dcd320 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,25 @@ +# Description + +Anything you'd like to add + +## Code example + +```Cpp +// Put your code here +``` + +### Expected result + +```Cpp +/** + * @brief Put the expected comment here + */ +``` + +### Actual result + +```Cpp +/** + * @brief Put the actually generated comment here + */ +``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0975969 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +# Fix/Feature/Other + +## Fix + +[ ] Link to issue. If there is no issue please describe it using at least the issue template + +[ ] Description of the fix + +[ ] Added unit test + +## Feature + +[ ] Description of what's added + +[ ] Gif of your feature if appropriate + +[ ] Added gif to README + +[ ] Added unit test + +## Other + +[ ] Description -- cgit v1.2.3