diff --git a/README.md b/README.md index f0b3181..81efcdf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ # issue-templates -My issue templates + +This repository keeps track of the issue templates I developed over time and throughout different projects and teams. + +The Templates follow simple guidelines to improve the workflow of the developers +- Simple, easy & comprehensible - not overloaded with massive amount of info +- Have visual cues using emoji icons to make it easier to identify contents +- Limited to 7 different templates covering most use cases for small teams + +This Repo also includes a Pullrequest template. + +## Labels + +Furthermore 7 different labels are defined, one for each Issue template. The use is optional, but if you intend to use them you have to create them manually in your repository. Those labels are: +- bug +- devops +- epic +- feature +- question +- refactor +- release + +## Preview + +The screen choosing the template looks like this: + +![choose](docu/choose.png) + +Below each Issue template is shown, when submitted empty + +### Bug Report + +![bug_report](docu/bug_report.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/1 + +### DevOps Ticket + +![devops_ticket](docu/devops_ticket.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/2 + +### Epic + +![epic](docu/epic.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/3 + +### Feature Request + +![feature_request](docu/feature_request.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/4 + +### Question + +![question](docu/question.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/5 + +### Refactor Ticket + +![refactor_ticket](docu/refactor_ticket.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/6 + +### Release + +![release](docu/release.png) +See: https://github.com/ulfgebhardt/issue-templates/issues/7 + +### Pullrequest \ No newline at end of file diff --git a/docu/bug_report.png b/docu/bug_report.png new file mode 100644 index 0000000..9c856d4 Binary files /dev/null and b/docu/bug_report.png differ diff --git a/docu/choose.png b/docu/choose.png new file mode 100644 index 0000000..a30152c Binary files /dev/null and b/docu/choose.png differ diff --git a/docu/devops_ticket.png b/docu/devops_ticket.png new file mode 100644 index 0000000..1ee6f74 Binary files /dev/null and b/docu/devops_ticket.png differ diff --git a/docu/epic.png b/docu/epic.png new file mode 100644 index 0000000..2394c41 Binary files /dev/null and b/docu/epic.png differ diff --git a/docu/feature_request.png b/docu/feature_request.png new file mode 100644 index 0000000..a35a507 Binary files /dev/null and b/docu/feature_request.png differ diff --git a/docu/question.png b/docu/question.png new file mode 100644 index 0000000..901d4ab Binary files /dev/null and b/docu/question.png differ diff --git a/docu/refactor_ticket.png b/docu/refactor_ticket.png new file mode 100644 index 0000000..a14b5c8 Binary files /dev/null and b/docu/refactor_ticket.png differ diff --git a/docu/release.png b/docu/release.png new file mode 100644 index 0000000..c03d3b2 Binary files /dev/null and b/docu/release.png differ