issue #692 Add the Github Issue Template Form #729

000xs · 2024-10-18T11:29:28Z

Resolves #692 : Created New Github Issue Template Form

Important

Add new GitHub issue templates for bug reports, documentation, feature requests, and discussions, and remove old markdown templates.

New Templates:
- Adds bug-report.yml for bug reports with fields for issue description, expected behavior, reproduction steps, and more.
- Adds documentation.yml for documentation issues with fields for issue description and proposed solutions.
- Adds feature-request.yml for feature requests with fields for description, proposed solution, and impact.
- Adds other.yml for general questions or discussions.
Removed Templates:
- Deletes bug_report_frontend.md, bug_report_sdk.md, custom.md, and feature_request.md markdown templates.

^{This description was created by}^{for 460a0fc. It will automatically update as commits are pushed.}

ellipsis-dev

👍 Looks good to me! Reviewed everything up to 460a0fc in 16 seconds

More details

Looked at 480 lines of code in 9 files
Skipped 0 files when reviewing.
Skipped posting 3 drafted comments based on config settings.

1. .github/ISSUE_TEMPLATE/bug-report.yml:1

Draft comment:
The name and title formatting in this file is inconsistent with the other bug report template (bug_report.yml). Consider standardizing the naming and title format across all templates for consistency.
Reason this comment was not posted:
Confidence changes required: 50%
The bug report templates have inconsistent naming and formatting, which could lead to confusion.

2. .github/ISSUE_TEMPLATE/documentation.yml:37

Draft comment:
The description contains a duplicated link to the Contributing Guidelines. Remove the redundant link to avoid confusion.
Reason this comment was not posted:
Confidence changes required: 50%
The documentation issue template has a duplicated link in the description, which is redundant.

3. .github/ISSUE_TEMPLATE/feature-request.yml:53

Draft comment:
There's a typo in the label description: [Code of Conduct](https://github.com/ComposioHQ/composio/blob/main/CODE_OF_ CONDUCT.md). Remove the space in CODE_OF_ CONDUCT.md.
Reason this comment was not posted:
Confidence changes required: 50%
The feature request template has a typo in the label description, which could lead to confusion.

Workflow ID: wflow_ZWompXZFE9jl1E0P

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

plxity · 2024-12-11T14:08:27Z

@000xs Thanks for working on this. Can you please record a video of this and share, just want to see if everything looks good visually.

tushar-composio

Double check all your changes and send a photo of these forms once fixed.

tushar-composio · 2024-12-19T12:32:09Z

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,119 @@
+name: " Bug Report"


typo? also there's two bug report forms

tushar-composio · 2024-12-19T12:32:19Z

.github/ISSUE_TEMPLATE/bug_report.yml

+  - type: textarea
+    id: something_wrong
+    attributes:
+      label: "What went wrong? "


remove space

tushar-composio · 2024-12-19T12:32:29Z

.github/ISSUE_TEMPLATE/bug_report.yml

+    id: terms_checklist_bug
+    attributes:
+      label: "Code of Conduct"
+      description: By submitting this issue, you agree to follow our [Code of Conduct](link_to_your_code_of_conduct) and [Contributing Guidelines](link_to_your_contributing_guidelines) (if applicable).


fix the URLs

tushar-composio · 2024-12-19T12:32:38Z

.github/ISSUE_TEMPLATE/bug-report.yml

+    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).


these URLs go to 404

tushar-composio · 2024-12-19T12:33:11Z

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,62 @@
+name: " Feature Request"
+description: "Have any new ideas or features for Composio? Please suggest!"
+title: "<write a small description here>"


titles should not be used like that

vercel · 2024-12-24T12:40:05Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
composio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 24, 2024 1:44pm

shreysingla11 · 2024-12-24T12:41:15Z

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,119 @@
+name: " Bug Report"


There are two bug report template files being added: bug-report.yml and bug_report.yml. These files have similar content but slight differences. This will cause confusion for users. Please consolidate these into a single bug report template.

shreysingla11 · 2024-12-24T12:41:25Z

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,119 @@
+name: " Bug Report"
+description: I would like to report a bug.
+title: "[ BUG] <write a small description here>"


The title format has inconsistent spacing "[ BUG]". For consistency, it should be "[BUG]" without extra spaces.

shreysingla11 · 2024-12-24T12:41:35Z

.github/ISSUE_TEMPLATE/bug_report.yml

+    id: terms_checklist_bug
+    attributes:
+      label: "Code of Conduct"
+      description: By submitting this issue, you agree to follow our [Code of Conduct](link_to_your_code_of_conduct) and [Contributing Guidelines](link_to_your_contributing_guidelines) (if applicable).


The Code of Conduct and Contributing Guidelines links are using placeholder text (link_to_your_code_of_conduct). Please replace these with the actual links to the repository's documents:

Code of Conduct: https://github.com/ComposioHQ/composio/blob/main/CODE_OF_CONDUCT.md

Contributing Guidelines: https://github.com/ComposioHQ/composio/blob/main/CONTRIBUTING.md

shreysingla11 · 2024-12-24T12:41:44Z

.github/ISSUE_TEMPLATE/bug_report.yml

+        - Brave
+        - Other
+
+  - type: input  # Assuming Composio works with different OS


The input type is used here for OS selection, but since you have predefined options, you should use dropdown type instead, similar to how the browser selection is implemented above. This will provide a better user experience and prevent invalid inputs.

shreysingla11 · 2024-12-24T12:41:52Z

.github/ISSUE_TEMPLATE/bug_report.yml

+      label: "Code of Conduct"
+      description: By submitting this issue, you agree to follow our [Code of Conduct](link_to_your_code_of_conduct) and [Contributing Guidelines](link_to_your_contributing_guidelines) (if applicable).
+      options:
+        - label: "I


The file appears to be cut off mid-sentence at line 119 with "I". Please complete the content and ensure all checkboxes are properly defined.

shreysingla11 · 2024-12-24T12:42:05Z

Code Review Summary

Overall, this PR makes a good improvement by moving from markdown-based templates to more structured YAML-based forms. However, there are several issues that need to be addressed:

Critical Issues:

Duplicate bug report templates need to be consolidated
Incomplete content in bug_report.yml (cut off at line 119)
Placeholder links need to be replaced with actual repository links

Improvements Needed:

Use consistent formatting for titles and labels across templates
Change input type to dropdown for OS selection
Consider adding character limits to text inputs
Add validation for version numbers
Consider adding templates for security vulnerabilities and performance issues

Positive Aspects:

✅ Good organization of different template types
✅ Comprehensive fields for bug reports
✅ Clear instructions and placeholders
✅ Proper use of required/optional fields

Please address the critical issues and consider the suggested improvements. Once these are fixed, the PR will be ready for merge.

Code Quality Rating: 7/10 (Good foundation but needs refinement)

000xs · 2024-12-24T13:41:01Z

Code Review Summary

Overall, this PR makes a good improvement by moving from markdown-based templates to more structured YAML-based forms. However, there are several issues that need to be addressed:

Critical Issues:

Duplicate bug report templates need to be consolidated

Incomplete content in bug_report.yml (cut off at line 119)

Placeholder links need to be replaced with actual repository links

Improvements Needed:

Use consistent formatting for titles and labels across templates

Change input type to dropdown for OS selection

Consider adding character limits to text inputs

Add validation for version numbers

Consider adding templates for security vulnerabilities and performance issues

Positive Aspects:

✅ Good organization of different template types ✅ Comprehensive fields for bug reports ✅ Clear instructions and placeholders ✅ Proper use of required/optional fields

Please address the critical issues and consider the suggested improvements. Once these are fixed, the PR will be ready for merge.

Code Quality Rating: 7/10 (Good foundation but needs refinement)

I fixed the typo. Please check if I missed anything.

000xs and others added 3 commits October 18, 2024 06:49

Create bug_report.yml

78a39c4

issue ComposioHQ#692 Add the Github Issue Template Form

72e1f6c

Merge branch '000xs' of https://github.com/000xs/composio into 000xs

460a0fc

ellipsis-dev bot reviewed Oct 18, 2024

View reviewed changes

tushar-composio requested changes Dec 19, 2024

View reviewed changes

sohamganatra closed this Dec 24, 2024

sohamganatra reopened this Dec 24, 2024

vercel bot deployed to Preview December 24, 2024 12:40 View deployment

shreysingla11 reviewed Dec 24, 2024

View reviewed changes

vercel bot deployed to Preview December 24, 2024 13:37 View deployment

000xs mentioned this pull request Dec 24, 2024

test #1087

Closed

vercel bot deployed to Preview December 24, 2024 13:44 View deployment

000xs added 2 commits December 24, 2024 09:06

fixed type

545194d

fix url ref

b27324d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

issue #692 Add the Github Issue Template Form #729

issue #692 Add the Github Issue Template Form #729

000xs commented Oct 18, 2024 •

edited by tushar-composio

Loading

ellipsis-dev bot left a comment

plxity commented Dec 11, 2024

tushar-composio left a comment

tushar-composio Dec 19, 2024

tushar-composio Dec 19, 2024

tushar-composio Dec 19, 2024

tushar-composio Dec 19, 2024

tushar-composio Dec 19, 2024

vercel bot commented Dec 24, 2024 •

edited

Loading

shreysingla11 Dec 24, 2024

shreysingla11 Dec 24, 2024

shreysingla11 Dec 24, 2024

shreysingla11 Dec 24, 2024

shreysingla11 Dec 24, 2024

shreysingla11 commented Dec 24, 2024

000xs commented Dec 24, 2024

Code Review Summary

Critical Issues:

Improvements Needed:

Positive Aspects:

issue #692 Add the Github Issue Template Form #729

Are you sure you want to change the base?

issue #692 Add the Github Issue Template Form #729

Conversation

000xs commented Oct 18, 2024 • edited by tushar-composio Loading

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

plxity commented Dec 11, 2024

tushar-composio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shreysingla11 commented Dec 24, 2024

Code Review Summary

Critical Issues:

Improvements Needed:

Positive Aspects:

000xs commented Dec 24, 2024

Code Review Summary

Critical Issues:

Improvements Needed:

Positive Aspects:

000xs commented Oct 18, 2024 •

edited by tushar-composio

Loading

vercel bot commented Dec 24, 2024 •

edited

Loading