Merge pull request #4 from amepproject/issue-templates

Issue templates

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,65 @@
+name: Bug report
+description: Report a bug.
+title: "BUG: <Please add a meaningful title after the 'BUG: ' prefix.>"
+labels: [bug]
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      Thank you for taking the time to report a bug. Before creating a new
+      issue, please check the [issue tracker](https://github.com/amepproject/amep/issues) 
+      for existing issues about the bug.
+      
+- type: textarea
+  attributes:
+    label: "Description:"
+    placeholder: |
+      Please add a precise description of the bug here.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Code for reproduction:"
+    placeholder: |
+      Please add a short code example that reproduces the problem. This code 
+      example should be self-contained, i.e., can be copy-pasted into the Python 
+      interpreter or run as-is via `python example.py`.
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Error message:"
+    placeholder: |
+      If the bug is causing an error message, please include the full error 
+      message (starting from `Traceback: ...`) here.
+      
+- type: textarea
+  attributes:
+    label: "Python and AMEP versions:"
+    placeholder: |
+      Please add the Python and AMEP versions you have used. These can be 
+      obtained via `import sys, amep; print(amep.__version__); print(sys.version)`.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Additional information:"
+    placeholder: |
+      Please add additional information here. This can include information about 
+      why you think this bug is happening, ideas to fix this bug, 
+      or information about how this issue affects your work.
+  validations:
+    required: false
+
+- type: dropdown
+  attributes:
+    label: "How did you install AMEP?"
+    options:
+      - pip
+      - conda
+      - from source

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Question/Help/Support
+    url: https://github.com/amepproject/amep/discussions
+    about: "If you have a question or need help/support, please use the GitHub discussions."

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,29 @@
+name: Documentation
+description: Report an issue related to the AMEP documentation at https://amepproject.de.
+title: "DOC: <Please add a meaningful title after the 'DOC: ' prefix.>"
+labels: [documentation]
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      Thank you for taking the time to report an issue related to the AMEP 
+      documentation. Before creating a new issue, please check the 
+      [issue tracker](https://github.com/amepproject/amep/issues) for existing 
+      issues.
+      
+- type: textarea
+  attributes:
+    label: "Problem description:"      
+    placeholder: |
+      Please add a description of the issue. Please make sure to add a 
+      reference to the document/code you are referring to. 
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Suggested content improvement:"
+    placeholder: |
+      Please describe what topics you think are missing from the current 
+      documentation.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,27 @@
+name: Feature request
+description: Request a new feature.
+title: "FRQ: <Please add a meaningful title after the 'FRQ: ' prefix."
+labels: [new feature]
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      Thank you for proposing/requesting a new feature. Please also check out 
+      our [Contributor Guide](https://github.com/amepproject/amep/blob/main/CONTRIBUTING.md) 
+      for more information about how to contribute to AMEP. Before creating a 
+      new issue, please check the 
+      [issue tracker](https://github.com/amepproject/amep/issues) for existing 
+      issues about your feature request. If you are not sure if your proposed 
+      new feature should be included in AMEP, you can also start a new 
+      [discussion](https://github.com/amepproject/amep/discussions) 
+      before creating an issue.
+      
+- type: textarea
+  attributes:
+    label: "Proposed new feature or change:"
+    placeholder: |
+      Please add a detailed description of your proposed new feature or change 
+      in functionality here.
+  validations:
+    required: true