documentation including screenshots

This commit is contained in:
Ulf Gebhardt 2021-09-18 20:14:33 +02:00
parent f53aaf6369
commit 3326fce7b2
No known key found for this signature in database
GPG Key ID: 81308EFE29ABFEBD
9 changed files with 65 additions and 1 deletions

View File

@ -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

BIN
docu/bug_report.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

BIN
docu/choose.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

BIN
docu/devops_ticket.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

BIN
docu/epic.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docu/feature_request.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

BIN
docu/question.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docu/refactor_ticket.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docu/release.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB