From 675754e17cbf752f94ad35fc5b779f77c51262f5 Mon Sep 17 00:00:00 2001
From: Taekyung Heo <7621438+TaekyungHeo@users.noreply.github.com>
Date: Mon, 13 May 2024 15:24:08 -0700
Subject: [PATCH] Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#113)

Summary:
Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE

Pull Request resolved: https://github.com/facebookresearch/param/pull/113

Test Plan: Not needed. These are the same templates used in https://github.com/mlcommons/chakra.

Differential Revision: D57299654

Pulled By: briancoutinho

fbshipit-source-id: 38b456180aadb8b09562fbbc1ef1e38a39ee8eff
---
 .github/ISSUE_TEMPLATE/bug_report.md       | 20 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md  | 13 +++++++++++++
 .github/ISSUE_TEMPLATE/general_question.md |  9 +++++++++
 .github/PULL_REQUEST_TEMPLATE.md           | 13 +++++++++++++
 4 files changed, 55 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/general_question.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 00000000..10ae23d5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,20 @@
+---
+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.
+
+## Steps to Reproduce
+> Steps to reproduce the behavior.
+> Please include the version information where the bug was observed.
+
+## Expected Behavior
+> A clear and concise description of what you expected to happen.
+
+## Screenshots
+> If applicable, add screenshots to help explain your problem.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..a2a493d1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,13 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+## Problem Related to the Feature
+> A clear and concise description of what the problem is.
+
+## Proposed Solution
+> A clear and concise description of what you want to happen.
diff --git a/.github/ISSUE_TEMPLATE/general_question.md b/.github/ISSUE_TEMPLATE/general_question.md
new file mode 100644
index 00000000..0dc55f0f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/general_question.md
@@ -0,0 +1,9 @@
+---
+name: General question
+about: Ask a question or seek clarification about the project
+title: ''
+labels: 'question'
+assignees: ''
+---
+
+> Please provide a detailed description of your question or the information you seek.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..4b89184e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+## Summary
+Provide a concise summary of the changes introduced by this pull request. Detail the purpose and scope of the changes, referencing any relevant issues or discussions. Explain how these changes address the problem or improve the project.
+
+## Test Plan
+In this section, describe the testing you have performed to verify the changes. Include:
+- A clear description of the testing environment.
+- The steps you followed to test the new features or bug fixes.
+- Any specific commands used during testing, along with their outputs.
+- A description of the results and observations from your testing.
+This information is crucial for reviewers to understand how the changes have been validated.
+
+## Additional Notes
+Include any other notes or comments about the pull request here. This can include challenges faced, future considerations, or context that reviewers might find helpful.