From 61f2c1032ce088a0e55ffd7b9e8916bdb05b10c9 Mon Sep 17 00:00:00 2001
From: Vianney Veremme <vianney@veremme.org>
Date: Mon, 14 Apr 2025 09:59:53 -0400
Subject: [PATCH] Add issue and pull request templates for better contribution
 guidelines

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 46 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++
 .github/pull_request_template.md          | 29 ++++++++++++++
 3 files changed, 98 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..a750db7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+## Describe the bug
+
+- A clear and concise description of what the bug is.
+
+## To Reproduce
+
+- Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+
+- A clear and concise description of what you expected to
+  happen.
+
+## Screenshots
+
+- If applicable, add screenshots to help explain your problem.
+
+## Desktop (please complete the following information)
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+## Mobile (please complete the following information)
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+## Additional context
+
+- Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..a24b863
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+## 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 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.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..d42fb3d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+# Pull Request Description
+
+## Brief Description of Changes
+
+Briefly explain the overall purpose of the changes made by this pull request.
+
+## Detailed Changes
+
+Please explain in detail the changes made by this pull request. Concisely present what each modification does.
+
+## Objective of Changes/Issue Resolved (if applicable)
+
+Precisely describe the objective of this pull request. Explain why these changes are necessary and how they enhance or resolve specific issues. Use tags like "Fixes #issue-number" or "Resolves the problem of [description]" if applicable.
+
+## Screenshots (if applicable)
+
+If relevant, include screenshots or animated gifs to visually illustrate the changes made.
+
+## Verification Steps
+
+Provide detailed steps that the reviewer can follow to verify your changes:
+
+1. Step 1...
+2. Step 2...
+3. etc.
+
+## Notes for Reviewer
+
+Include here any relevant additional information or specific points the reviewer should focus on when reviewing this pull request.