ADD Backend Issue Report Template #467
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. |
|
Warning Rate limit exceeded@RamakrushnaBiswal has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 47 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughA new issue template for backend issues has been added to the repository. The template is designed to guide users in reporting backend problems by providing a structured format that includes sections for preliminary checks, issue summary, steps to reproduce, expected vs actual behavior, logs/errors, and additional information. This enhancement aims to improve the clarity and consistency of issue reporting. Changes
Assessment against linked issues
Possibly related issues
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: 3
🧹 Outside diff range and nitpick comments (4)
.github/ISSUE_TEMPLATE/backend_issue.yml (4)
1-4: Consider expanding the label options.While the current labels ["Backend", "Bug"] are appropriate for bug reports, backend issues might also include feature requests or improvements. Consider adding a type field to differentiate between bugs, features, and improvements, or expanding the labels list.
name: "🔧 Backend Issue Report" description: "Create a detailed report to help us improve the backend services." title: "BACKEND ISSUE:" -labels: ["Backend", "Bug"] +labels: ["Backend"]Then add a type selector:
- type: dropdown attributes: label: "Issue Type" description: "What type of backend issue is this?" options: - Bug - Feature Request - Improvement validations: required: true
15-20: Refine the issue summary description.The current description asks for expected and actual behavior, which are separate fields later in the template. This might lead to duplicate information.
- 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 clear and concise description of what the issue is." validations: required: true
21-26: Add format suggestion for reproduction steps.Help users provide better structured information by suggesting a format in the description.
- type: textarea attributes: label: "Steps to Reproduce" - description: "List the steps to reproduce the issue. Include specific details, such as API endpoints, request parameters, etc." + description: | + List the steps to reproduce the issue. Include specific details such as: + 1. API endpoint used (e.g., `/api/v1/users`) + 2. HTTP method (GET, POST, etc.) + 3. Request parameters/payload + 4. Headers (if relevant) + 5. Authentication details (token/key used, if applicable) validations: required: true
33-38: Add formatting guidelines for logs/errors.Help users provide logs in a readable format.
- type: textarea attributes: label: "Logs/Errors" - description: "If applicable, attach logs or error messages that can help us diagnose the issue." + description: | + Please provide any relevant logs or error messages. Format them as follows: + 1. Use code blocks (```) for log entries + 2. Include timestamp and log level if available + 3. Highlight the specific error message + 4. Remove any sensitive information + render: shell validations: required: false
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
RamakrushnaBiswal
merged commit e839495
into
RamakrushnaBiswal:main
RamakrushnaBiswal
added
documentation
Issue Title
Please enter the title of the issue related to your pull request.
Enter the issue title here- Backend Issue Report Template
Info about the Related Issue
What's the goal of the project?
Describe the project's aim- To improve backend functionality and streamline issue reporting for better project 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 to 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: #462
Describe the Add-ons or Changes You've Made
Give a clear description of what you have added or modified.
Describe your changes here- Added a structured backend issue report template to standardize and improve issue tracking and management.
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. The template was tested by creating a sample pull request to ensure all fields and checkboxes work correctly in Markdown format.
Checklist
Please confirm the following:
Summary by CodeRabbit