Skip to content

Commit

Permalink
issue ComposioHQ#692 Add the Github Issue Template Form
Browse files Browse the repository at this point in the history
  • Loading branch information
000xs committed Oct 18, 2024
1 parent 4f3bb98 commit 72e1f6c
Show file tree
Hide file tree
Showing 8 changed files with 245 additions and 50 deletions.
103 changes: 103 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
name: "🐛 Bug Report"
description: Create a report to help us improve
title: "[BUG] <write a small description here>"
labels: ["bug"] # Assuming "bug" is the appropriate label for Composio

body:
- type: markdown
attributes:
value: |
- Thank you for using Composio and taking the time to report a bug!
- type: textarea
id: something_wrong
attributes:
label: "What went wrong? "
description: Please provide a detailed description of the issue you encountered. Be clear and concise in explaining what is not working as expected.
placeholder: The description of the issue you experienced in detail, including any relevant information or context.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: "Expected Behavior"
description: Please describe how you expected the system to behave when you encountered the issue.
placeholder: The description of the behavior that you expected to see when encountering the issue.

- type: textarea
id: reproduction_steps
attributes:
label: "Steps to Reproduce Issue"
description: If possible, please share the steps to reproduce the issue.
placeholder:
- List the steps that lead to the bug.
- Include relevant actions and expected outcomes.

- type: textarea
id: solution_proposed
attributes:
label: "Solution Proposed"
description: Any ideas on how this should be solved (optional)
placeholder: The potential solution to solve this issue (optional)

- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
!["DESCRIPTION"](LINK.png) # Replace with your screenshot format
validations:
required: false

- type: input
id: environment
attributes:
label: "Runtime Environment"
description: You can specify your operating system and version, software version, or any other relevant details.
placeholder: ex. Windows 10, Composio v1.2.3

- type: input # Assuming Composio works with different OS
id: os
attributes:
label: "OS"
description: Please select the operating system(s) on which you are experiencing the issue.
multiple: true
options:
- Windows
- Linux
- Mac
- iOS
- Android
- Other

- type: textarea # Assuming Composio has versions
id: version_composio
attributes:
label: "Version of Composio"
description: Please provide the version number of Composio you are using (if applicable).
placeholder: ex. 1.2.3

- type: textarea
id: additional_context
attributes:
label: "Additional Context"
description: If you have any additional context or information that may help us understand the problem better, please provide it here.
placeholder: This can include any relevant logs, error messages, or other information.
render: bash # Adjust render type if needed

- type: markdown
attributes:
value: Thank you for taking the time to report the issue!

- type: checkboxes
id: terms_checklist_bug
attributes:
label: "Code of Conduct"
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ComposioHQ/composio/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/ComposioHQ/composio/blob/main/CONTRIBUTING.md) and [Contributing Guidelines](link_to_your_contributing_guidelines) (if applicable).
options:
- label: "I have checked the [existing issues](https://github.com/ComposioHQ/composio/issues)."
required: true
- label: "I am willing to work on this issue (optional)"
required: false
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report_frontend.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report_sdk.md

This file was deleted.

1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: "📄 Documentation Issue"
description: "Use this form to suggest improvements for our documentation."
title: "[DOCS] <write a small description here>"
labels: ["documentation"] # Assuming "documentation" is the appropriate label

body:
- type: markdown
attributes:
value: |
- Thank you for using Composio and taking the time to suggest improvements in the documentation!
- type: textarea
id: docs_description
attributes:
label: "Issue Description"
description: "Please provide a brief summary of the documentation issue you are experiencing or would like to address."
validations:
required: true

- type: textarea
id: screenshots_examples_docs
attributes:
label: "Screenshots or Examples (if applicable)"
description: "Please include relevant screenshots or examples to help illustrate the problem."

- type: textarea
id: proposed_solution_docs
attributes:
label: "Proposed Solution (optional)"
description: "If you have a proposed solution for the documentation issue, please provide it here. This can be helpful for speeding up the resolution process."

- type: checkboxes
id: terms_checklist_docs
attributes:
label: "Code of Conduct"
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ComposioHQ/composio/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/ComposioHQ/composio/blob/main/CONTRIBUTING.md) and [Contributing Guidelines](link_to_your_contributing_guidelines) (if applicable).
options:
- label: "I have checked the [existing issues](https://github.com/ComposioHQ/composio/issues)."
required: true
- label: "I am willing to work on this issue (optional)"
required: false

- type: markdown
attributes:
value: Thank you for taking the time to suggest improvements!
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: " Feature Request"
description: "Have any new ideas or features for Composio? Please suggest!"
title: "<write a small description here>"
labels: ["✨ enhancement"] # Assuming "new-feature" is the appropriate label
body:
- type: markdown
attributes:
value: |
- Thank you for using Composio and taking the time to suggest a new feature!

- type: textarea
id: description_feature
attributes:
label: "Description"
description: "Please describe the missing functionality that this feature would address."
placeholder: "A detailed description of the new feature request."
validations:
required: true

- type: textarea
id: feature_solution_proposed
attributes:
label: "Proposed Solution"
description: "Describe how you envision this functionality implemented in Composio."
placeholder: "Include sketches, wireframes, or flowcharts to illustrate your proposal (optional)."

- type: textarea
id: feature_impact_solution
attributes:
label: "Impact of Solution"
description: "How could this feature affect the rest of Composio? Are there any specific considerations?"
placeholder: "Describe any relevant information about the feature's impact."

- type: textarea
id: additional_context_feature
attributes:
label: "Additional Context"
description: "Provide any additional information that may help implement this feature (workarounds, third-party solutions, etc.)."
validations:
required: false

- type: markdown
attributes:
value: |
You can view our development roadmap on the [Composio website](https://composiohq.com/roadmap)
to see if your feature request is already planned.
- type: checkboxes
id: terms_checklist_feature
attributes:
label: "Code of Conduct"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ComposioHQ/composio/blob/main/CODE_OF_ CONDUCT.md) and [Contributing Guidelines](https://github.com/ComposioHQ/composio/blob/main/CONTRIBUTING.md)."
options:
- label: "I have checked the [existing issues](https://github.com/ComposioHQ/composio/issues?q=is%3Aissue+)."
required: true
- label: "I am willing to work on this issue (optional)"
required: false

- type: markdown
attributes:
value: Thank you for taking the time to suggest a new feature!
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Other
description: Use this for any other question or discussion related to Composio. Please do not create blank issues.
title: "[OTHER] <write a small description here>"
labels: ["question"] # Assuming "question" is the appropriate label for general discussions

body:
- type: markdown
attributes:
value: |
Thank you for using Composio and taking the time to submit this issue!
- This is for any questions, discussions, or feedback you may have about Composio.
- type: textarea
id: issuedescription
attributes:
label: "What would you like to share or ask?"
description: "Provide a clear and concise explanation of your question, discussion topic, or feedback."
validations:
required: true

- type: checkboxes
id: terms_checklist_discussion
attributes:
label: "Code of Conduct"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ComposioHQ/composio/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/ComposioHQ/composio/blob/main/CONTRIBUTING.md)."
options:
- label: "I have checked the [existing issues](https://github.com/ComposioHQ/composio/issues?q=is%3Aissue+)."
required: true
- label: "I am willing to work on this issue (optional)"
required: false

- type: markdown
attributes:
value: Thank you for reaching out! We look forward to your question or discussion.

0 comments on commit 72e1f6c

Please sign in to comment.