Add ISSUE_TEMPLATE, Add PULL_REQUEST_TEMPLATE, Update README.md (#27)

* Add ISSUE_TEMPLATE, Add PULL_REQUEST_TEMPLATE Added ISSUE_TEMPLATE Added 1-issue.yml Added 2-feature.yml Added 1-bug.yml Added PULL_REQUEST_TEMPLATE.md Refer to Issue #8. Signed-off-by: Murkeee <[email protected]> * Update README.md Added Video for pytest demo Closes #16. Signed-off-by: Murkeee <[email protected]> --------- Signed-off-by: Murkeee <[email protected]>
SkywardAI · Aug 4, 2024 · d2d84e6 · d2d84e6
1 parent d4837b1
commit d2d84e6
Show file tree

Hide file tree

Showing 5 changed files with 126 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-issue.yml b/.github/ISSUE_TEMPLATE/1-issue.yml
@@ -0,0 +1,33 @@
+name: Issue Report
+description: File an issue report.
+title: "[Issue]: "
+labels: ["issue"]
+projects: ["SkywardAI/voyager"]
+assignees:
+  - 
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this issue report.
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details(optional)
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What is the issue you are having?
+      placeholder: Tell us your issue.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml
@@ -0,0 +1,23 @@
+name: Feature Request
+description: File a feature request.
+title: "[Feature]: "
+labels: ["feature", "improvement"]
+projects: ["SkywardAI/voyager"]
+assignees:
+  -
+body:
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details(optional)
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: What feature are you requesting?
+      placeholder: Tell us what your feature.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/3-bug.yml b/.github/ISSUE_TEMPLATE/3-bug.yml
@@ -0,0 +1,43 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug]: "
+labels: ["bug"]
+projects: ["SkywardAI/voyager"]
+assignees:
+  - 
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report.
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details(optional)
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what happened.
+    validations:
+      required: true
+  - type: textarea
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      placeholder: Tell us your software version
+      value: "Example: 0.2.4"
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,22 @@
+**Description**
+
+This PR fixes #
+
+**Notes for Reviewers**
+
+
+**[Signed commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)**
+- [ ] Yes, I signed my commits.
+
+<!--
+Thank you for contributing to  SkywardAI! 
+
+Contributing Conventions:
+
+1. Include descriptive PR titles with [<component-name>] prepended.
+2. Build and test your changes before submitting a PR. 
+3. Sign your commits
+
+By following the community's contribution conventions upfront, the review process will 
+be accelerated and your PR merged more quickly.
+-->
diff --git a/example/README.md b/example/README.md
@@ -1,6 +1,11 @@
 
 # Demo for how to use openai API client to invoke voyager API
 
+### Example Video
+
+https://github.com/user-attachments/assets/75d5d380-20df-4d88-b94a-19bc4fabc224
+
+
 ## Prerequisites
 
 - Python 3.10^