summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrahulp132022-06-12 20:49:34 +0530
committerrahulp132022-06-12 20:49:34 +0530
commit949da5a11613c95155d36f6d026233ecd8c3e892 (patch)
tree3dab2d048a355e7e6bf587aac88060a0d34449e6
parent6af18ac0a1e4148f72854d872a72ab86bf24726e (diff)
downloadeSim-949da5a11613c95155d36f6d026233ecd8c3e892.tar.gz
eSim-949da5a11613c95155d36f6d026233ecd8c3e892.tar.bz2
eSim-949da5a11613c95155d36f6d026233ecd8c3e892.zip
created issue and PR templates
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md35
-rw-r--r--.github/ISSUE_TEMPLATE/first_bug_report.md32
-rw-r--r--.github/pull_request_template.md11
3 files changed, 78 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..3ab1e2d0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,35 @@
+---
+name: Bug Report
+about: "Report a problem to help us improve \U0001F680"
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Description
+
+<!--- A clear and concise description of what the bug is. -->
+
+### Steps to Reproduce
+
+<!--- This could be a list of actions and possibly the eSim project files -->
+
+### Expected Behavior
+
+<!--- A clear and concise description of what you expected to happen. -->
+
+### Screenshots
+
+<!--- If applicable, add screenshots to help explain your problem. -->
+
+### Version and OS
+
+<!--- Please complete the following information. -->
+
+ - eSim version
+ - OS: [e.g. Windows 10, 64 bit]
+
+### Additional Context
+
+<!--- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/first_bug_report.md b/.github/ISSUE_TEMPLATE/first_bug_report.md
new file mode 100644
index 00000000..bcc68ada
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/first_bug_report.md
@@ -0,0 +1,32 @@
+---
+name: First Bug Report
+about: Detailed guideline for your first bug report
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Description
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+Please provide us with enough information to reproduce the issue on our side, otherwise it's hard to fix it. You can provide a list of actions, and possibly attach eSim project files including Verilog/VHDL code (if used at all).
+
+If you can provide a [minimal working example](https://en.wikipedia.org/wiki/Minimal_working_example) that shows the problem, instead of your original project, reproducing the bug is more straightforward and we can respond faster.
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Additional files
+You can add additional files via drag-and-drop, possibly compressed in zip format and attaching it.
+
+### Version and OS
+ - eSim version
+ - OS: [e.g. Windows 10, 64 bit, Ubuntu 20.04 LTS]
+
+### Additional context
+Add any other context about the problem here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..0124c04e
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,11 @@
+### Related Issues
+
+<!-- Link to the issues that are solved with this PR. -->
+
+### Purpose
+
+<!--- Describe the problem or feature. -->
+
+### Approach
+
+<!--- How does this address the problem? -->