diff options
| author | Christoph Schlosser <thisisagap@gmail.com> | 2017-12-16 21:28:46 +0100 |
|---|---|---|
| committer | Christoph Schlosser <christophschlosser@users.noreply.github.com> | 2017-12-16 21:48:09 +0100 |
| commit | bc81ab097ec8657a72776333d3b4122dbb23b673 (patch) | |
| tree | 4a8333ad7eed0ad77ef8110edc42954c07324e35 /.github | |
| parent | 4c5c82fcef969c07e9a9abde09af159735664416 (diff) | |
| download | doxdocgen-bc81ab097ec8657a72776333d3b4122dbb23b673.tar.gz | |
Add issue and PR template
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 25 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 23 |
2 files changed, 48 insertions, 0 deletions
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 |