Merge pull request #649 from habibayassin/orfs-issue-forms

add issue forms

Author: vvbandeira

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,120 @@
+name: OpenROAD Bug report with OpenROAD Flow Scripts 
+description: File a bug report if you are running OpenROAD from OpenROAD Flow Scripts
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! It helps us more quickly track, narrow down, and address bugs.
+  - type: dropdown
+    id: version
+    attributes:
+      label: Subject
+      description: Choose the category that best fits your bug/problem.
+      options:
+        - "[Documentation] for documentation errors."
+        - "[Build] for compilation-related issues."
+        - "[Flow] for any util, flow Makefile, or flow script issues."
+        - "[Design] for example design issues (i.e. the design does not pass functional validation, etc.)"
+        - "[Stage]: Synthesis."
+        - "[Stage]: Floorplaning."
+        - "[Stage]: I/O Placement."
+        - "[Stage]: CTS."
+        - "[Stage]: Global Placement."
+        - "[Stage]: Detail Placement."
+        - "[Stage]: Global Router."
+        - "[Stage]: Detail Router."
+        - "[Stage]: GDS generation."
+        - "[Stage]: Other. Please describe below."
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ---
+        #### This part is incredibly important:
+
+        Please run the following shell command in the OpenROAD root folder e.g "tools/OpenROAD":
+        ```
+        ./etc/Env.sh
+        ```
+        Then copy and paste the ENTIRE output in the text field below.
+
+        *If the command **does not succeed**, you are using an out-of-date version of OpenROAD, and it is recommended that you update.*
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      render: shell
+      description: Please paste the output from the previous command. It will be automatically formatted into code, so no need for backticks.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ---
+        #### To reproduce the bug: 
+        ##### You have two options here:
+
+        A. Use `make <SCRIPT_NAME>_issue` to create a tar file with all the files to reproduce the bug(s).
+
+        &nbsp;&nbsp;&nbsp;&nbsp;Steps:
+
+        &nbsp;&nbsp;&nbsp;&nbsp;1. Head to the flow directory e.g "./flow"
+
+        &nbsp;&nbsp;&nbsp;&nbsp;2. Set the ISSUE_TAG variable to rename the generated tar file
+
+        &nbsp;&nbsp;&nbsp;&nbsp;3. Run `make {script}_issue` in the directory "OpenROAD-flow-scripts/flow" where script is wildcarded from the "OpenROAD-flow-scripts/scripts" directory e.g `make cts_issue`
+                                          
+        &nbsp;&nbsp;&nbsp;&nbsp;4. Upload the generated tar file
+
+        B. Upload relevant files
+
+        &nbsp;&nbsp;&nbsp;&nbsp;- Upload a tar file containing the relevant files (.def, .lef and flow.tcl).
+
+        &nbsp;&nbsp;&nbsp;&nbsp;- List the commands used.
+  - type: textarea
+    id: to-reproduce
+    attributes:
+      label: To Reproduce
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: ---
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Feel free to add any relevant log snippets to this section. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, drag and drop screenshots to help explain your problem.
+    validations:
+      required: false
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+    validations:
+      required: false