archive-gh-me/gitmoji
1
0
Fork 0
mirror of https://github.com/carloscuesta/gitmoji.git synced 2025-12-08 20:14:12 +00:00
Code Issues Projects Releases Wiki Activity

📝 Update gitmoji proposal issue template (#1198)

Browse Source 
Closes #1120
This commit is contained in:
Vinícius Hoyer 2022-11-16 14:51:32 -03:00 committed by GitHub
parent ce019dfcd3
commit 412acfa776
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
.github/ISSUE_TEMPLATE/gitmoji-proposal.yml vendored
View File

@ -47,12 +47,23 @@ body:
- "No ❌"
validations:
required: true
- type: textarea
- type: checkboxes
id: emoji-what-how
attributes:
label: Does this emoji fall into the "how" category?
description: Explain the creation of this emoji, what this is and when it should be used
placeholder: We are trying to always describe/categorize the "what" has been done in one particular commit (:white_check_mark:, :lock:, :zap:...), not the "how" it was done (the exceptions being :hankey:, :beers:)
label: Does this emoji fall into the "how" or the "what" category?
description: |
We are trying to always describe/categorize "what" has been done in a particular commit, not the "how" it was done (the exceptions being :poop: and :beers:).
Notice here that, by the descriptions on the "how" category, you can't know what has been achieved in the commit.
| Examples of "what" commits | Examples of "how" commits |
| -------------------------- | ------------------------- |
| :white_check_mark: Add, update, or pass tests | :hankey: Write bad code that needs to be improved |
| :lock: Fix security issues | :beers: Write code drunkenly |
| :zap: Improve performance | :robot: Write an automated commit by a script |
options:
- label: This proposal do **not** describe "how" a commit was made, but does in fact describe "what" is the contents of the commit about.
required: true
validations:
required: true
- type: textarea
@ -74,4 +85,4 @@ body:
- label: Read the [Contributing Guide](https://github.com/carloscuesta/gitmoji/blob/master/.github/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue requesting the emoji.
required: true
required: true