From e3eab2246cff6fa1a03d33e3efc3d24f9eaedebf Mon Sep 17 00:00:00 2001
From: Tony Hsu <tony.hsu@datadoghq.com>
Date: Tue, 16 Jul 2024 13:49:01 +0200
Subject: [PATCH] Update templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 52 +++++++++++++++--------
 .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++-----
 docs/CONTRIBUTING.md                      |  2 +
 3 files changed, 46 insertions(+), 30 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index fb99560..c495fc0 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,26 +1,42 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-title: "[BUG] ..."
-labels: ''
-assignees: ''
-
+about: Create a report for a defect
+title: "..."
+labels: 'category/bug'
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+### Description
+
+<!-- Describe the problem clearly and concisely. -->
+
+### Expected behavior
+
+<!-- What did you expect to happen? -->
+
+### Actual behavior
+
+<!-- What happened instead? -->
+
+### Steps to reproduce
+
+1. <!-- ... -->
+2. <!-- ... -->
+3. <!-- ... -->
+
+### Screenshots, logs, and other output
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. ...
-2. ...
-3. ...
+<!-- If applicable, add more material to help explain your problem. -->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+<details>
+	<summary>Details</summary>
+	<pre><code>
+  <!-- Add logs here -->
+  </code></pre>
+</details>
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Additional context
 
-**Additional context**
-Add any other context about the problem here.
+Environment:
+- gem version:
+- Ruby engine version:
+- OS and/or container image:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 02d612b..1969007 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,18 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[FEATURE] ..."
-labels: ''
-assignees: ''
-
+title: "..."
+labels: 'category/feature'
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### Is your feature request related to a problem? Please describe
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 2afc315..0e513e7 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -20,6 +20,8 @@ Always write a clear log message for your commits. One-line messages are fine fo
     >
     > A paragraph describing what changed and its impact."
 
+If in doubt, follow [this](https://cbea.ms/git-commit/).
+
 ## Coding conventions
 
 Start reading our code and you'll get the hang of it. To avoid bikeshedding, run `bundle exec rubocop` and everything be fine.