Merge pull request #8 from ulfgebhardt/pullrequest

Pullrequest

README.md

@@ -1,2 +1,69 @@
 # 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
+
+![pullrequest](docu/pullrequest.png)
+See: https://github.com/ulfgebhardt/issue-templates/pull/8