From 2c61abdab311505e39aafd0ba5904cf25a355fa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Hoyer?= Date: Tue, 15 Nov 2022 14:46:12 -0300 Subject: [PATCH 1/4] Update gitmoji-proposal.yml Closes #1120 --- .github/ISSUE_TEMPLATE/gitmoji-proposal.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml index bb50a9aae1..13eeb720f8 100644 --- a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml +++ b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml @@ -47,12 +47,14 @@ 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:) + description: 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:) + options: + - label: This proposal do not describe "how" a commit was made, but do in fact describe "what" is the contents of the commit about. + required: true validations: required: true - type: textarea @@ -74,4 +76,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 From c91830e70c1ea950ae5678b5265af12ed6462427 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Hoyer?= Date: Wed, 16 Nov 2022 09:17:53 -0300 Subject: [PATCH 2/4] :pencil2: (issue template): Fix grammar and markup --- .github/ISSUE_TEMPLATE/gitmoji-proposal.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml index 13eeb720f8..e568812cf7 100644 --- a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml +++ b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml @@ -53,7 +53,7 @@ body: label: Does this emoji fall into the "how" category? description: 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:) options: - - label: This proposal do not describe "how" a commit was made, but do in fact describe "what" is the contents of the commit about. + - 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 From 4502b5d0bc0275c51cdd29b0d7c93f1fea1129df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Hoyer?= Date: Wed, 16 Nov 2022 09:19:26 -0300 Subject: [PATCH 3/4] :memo: (issue template): Improve what/how question display --- .github/ISSUE_TEMPLATE/gitmoji-proposal.yml | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml index e568812cf7..a10e00364a 100644 --- a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml +++ b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml @@ -50,8 +50,20 @@ body: - type: checkboxes id: emoji-what-how attributes: - label: Does this emoji fall into the "how" category? - description: 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. + + 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: + * :white_check_mark: Add, update, or pass tests + * :lock: Fix security issues + * :zap: Improve performance + + Examples of "how" commits: + * :hankey: Write bad code that needs to be improved + * :beers: Write code drunkenly 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 From bd6892013684ae48247f2c4c9383129eef9f7297 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Hoyer?= Date: Wed, 16 Nov 2022 09:25:16 -0300 Subject: [PATCH 4/4] :memo: (issue template): display examples on a table --- .github/ISSUE_TEMPLATE/gitmoji-proposal.yml | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml index a10e00364a..dd04cf0efd 100644 --- a/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml +++ b/.github/ISSUE_TEMPLATE/gitmoji-proposal.yml @@ -52,18 +52,15 @@ body: attributes: 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. + 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: - * :white_check_mark: Add, update, or pass tests - * :lock: Fix security issues - * :zap: Improve performance - - Examples of "how" commits: - * :hankey: Write bad code that needs to be improved - * :beers: Write code drunkenly + | 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