Pull Request & Issue Templates

.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -0,0 +1,41 @@
+name: 🐛 Bug Report
+description: Submit a bug report to help improve modalities
+labels: [ "bug" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        #### Before submitting a bug report, please make sure the issue hasn't already been addressed, by searching through [the existing and past issues](https://github.com/Modalities/modalities/issues).
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Please share your system info with us.
+      placeholder: modalities version, platform, python version, ...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: 🐛 Describe the bug
+      description: |
+        Please provide a clear and concise description of what the bug is. If relevant, add a minimal example so that we can reproduce the error by running the code. Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception.
+      placeholder: |
+        A clear and concise description of what the bug is.
+
+        ```python
+        # Sample code to reproduce the problem
+        ```
+
+        ```
+        The error message you got, with the full traceback.
+        ```
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,23 @@
+name: 📚 Documentation
+description: Report an issue related to https://modalities.github.io/modalities/
+labels: [ "documentation" ]
+
+body:
+  - type: textarea
+    attributes:
+      label: 📚 The doc issue
+      description: >
+        A clear and concise description of what content in https://modalities.github.io/modalities/ is an issue.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Suggest a potential alternative/fix
+      description: >
+        Tell us how we could improve the documentation in this regard.
+
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/feature-request.yaml

@@ -0,0 +1,27 @@
+name: 🚀 Feature Request
+description: Submit a proposal/request for a new modalities feature
+labels: [ "feature" ]
+
+body:
+  - type: textarea
+    id: feature-request
+    validations:
+      required: true
+    attributes:
+      label: Feature request
+      description: |
+        A clear and concise description of the feature proposal.
+
+  - type: textarea
+    id: motivation
+    validations:
+      required: true
+    attributes:
+      label: Motivation
+      description: |
+        Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link it here, too.
+
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for contributing 🎉!

.github/pull_request_template.md

@@ -1,7 +1,16 @@
 # What does this PR do?
 
-Add your description here, e.g. "This PR fixes issue #.. by .."
+This PR ..
 
+## General Changes
+* ..
 
-## Before submitting
-- [ ] I have fixed all failing tests (`python tests/tests.py`)
+## Breaking Changes
+* .. 
+
+## Checklist before submitting final PR
+- [ ] My PR is minimal and addresses one issue in isolation
+- [ ] I have merged the latest version of the target branch into this feature branch
+- [ ] I have reviewed my own code w.r.t. correct implementation, missing type hints, proper documentation, etc.
+- [ ] I have run a sample config for model training
+- [ ] I have checked that all tests run through (`python tests/tests.py`)