ADD Front end Issue Report Template #468
Conversation
|
@alo7lika is attempting to deploy a commit to the bunty's projects Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughA new issue template for frontend issues has been introduced in the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊 |
|
@RamakrushnaBiswal The task has been completed. Kindly review the PR. Don't forget to add label "GSSOC-EXT" |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
.github/ISSUE_TEMPLATE/frontend_issue.yml (3)
1-4: Improve template metadata for better issue categorization.Consider the following improvements:
- Remove "FRONTEND ISSUE:" prefix from the title as it's redundant with the template name and Frontend label
- Add more label options like "enhancement", "feature-request" to accommodate different types of frontend issues
name: "🌐 Frontend Issue Report" description: "Create a detailed report to help us improve the frontend user experience." -title: "FRONTEND ISSUE:" +title: "" -labels: ["Frontend", "Bug"] +labels: ["Frontend"]
15-38: Enhance field descriptions with examples for better guidance.The template would be more user-friendly with example content in the descriptions.
attributes: label: "Steps to Reproduce" - description: "List the steps to reproduce the issue, including which pages or components are affected." + description: | + List the steps to reproduce the issue, including which pages or components are affected. + Example: + 1. Go to '/login' page + 2. Enter email but leave password empty + 3. Click 'Login' button + 4. Notice error message is not displayed validations: required: true
39-45: Add Code of Conduct link and workaround field.Enhance the additional information section with more context and useful information.
label: "Additional Information" options: - - label: "I agree to follow this project's Code of Conduct" + - label: "I agree to follow this project's [Code of Conduct](../CODE_OF_CONDUCT.md)" required: true - label: "I can provide more details if needed" + - type: textarea + attributes: + label: "Temporary Workaround" + description: "If you've found a way to temporarily work around this issue, please share it to help other users." + validations: + required: false
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.github/ISSUE_TEMPLATE/frontend_issue.yml (2)
21-44: Consider streamlining the issue details sections.To improve clarity and reduce redundancy:
- Consider merging "Expected vs Actual Behavior" into "Issue Summary" since they often overlap
- Add a placeholder example for the Screenshots/Recordings section to guide users
- type: textarea attributes: label: "Issue Summary" - description: "Provide a concise summary of the issue, including what you expected to happen and what actually happened." + description: "Provide a concise summary of the issue, including:\n- What you were trying to do\n- What you expected to happen\n- What actually happened" validations: required: true - type: textarea attributes: label: "Steps to Reproduce" description: "List the steps to reproduce the issue, including which pages or components are affected." validations: required: true - - type: textarea - attributes: - label: "Expected vs Actual Behavior" - description: "What did you expect to happen instead of the current behavior?" - validations: - required: false - type: textarea attributes: label: "Screenshots/Recordings" - description: "If applicable, attach screenshots or recordings that illustrate the issue." + description: "If applicable, attach screenshots or recordings that illustrate the issue.\n\nTip: You can drag and drop images here, or paste them from clipboard." validations: required: false
45-51: Enhance the additional information section.Consider adding:
- A link to the Code of Conduct for easy reference
- Contact preferences for follow-up questions
- type: checkboxes attributes: label: "Additional Information" options: - - label: "I agree to follow this project's Code of Conduct" + - label: "I agree to follow this project's [Code of Conduct](../CODE_OF_CONDUCT.md)" required: true - - label: "I can provide more details if needed" + - label: "I can provide more details if needed (preferred contact method: GitHub, Email)" + description: "Please indicate your preferred contact method in parentheses"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/frontend_issue.yml(1 hunks)
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/frontend_issue.yml (1)
6-20: LGTM! Comprehensive preliminary checks implemented.
The preliminary checks section effectively captures all essential information, including browser details, OS, and device type.
RamakrushnaBiswal
added
documentation
RamakrushnaBiswal
merged commit d8a6d9c
into
RamakrushnaBiswal:main
Issue Title
Please enter the title of the issue related to your pull request.
Enter the issue title here- Front End Issue Report Template
Info about the Related Issue
What's the goal of the project?
Describe the aim of the project- To enhance the front end of the project by providing a structured issue reporting template, which helps streamline issue reporting and tracking.
Name
Please mention your name.
Enter your name here- Alolika Bhowmik
GitHub ID
Please mention your GitHub ID.
Enter your GitHub ID here- alo7lika
Identify Yourself
Mention in which program you are contributing (e.g., WoB, GSSOC, SSOC, Hacktoberfest).
Enter your participant role here- Contributor GSSOC 2024
Closes
Enter the issue number that will be closed through this PR.
Closes: #issue-number Closes: #463
Describe the Add-ons or Changes You've Made
Give a clear description of what you have added or modified.
Describe your changes here- Created a standardized issue report template for front-end issues to improve project management and communication.
Type of Change
Select the type of change:
How Has This Been Tested?
Describe how your changes have been tested.
Describe your testing process here. Verified by creating a test pull request to ensure that the template fields are functional and display correctly in Markdown.
Checklist
Please confirm the following:
Summary by CodeRabbit