From 412acfa776939b7bd1f72fceb458cb3c47ce3fe9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Hoyer?= Date: Wed, 16 Nov 2022 14:51:32 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20gitmoji=20proposal=20is?= =?UTF-8?q?sue=20template=20(#1198)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes #1120 --- .github/ISSUE_TEMPLATE/gitmoji-proposal.yml | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml index bb50a9a..dd04cf0 100644 --- a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml +++ b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml @@ -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 \ No newline at end of file + required: true