8000 Add 2 issue templates by gitauto-ai[bot] · Pull Request #1 · abdulrahman305/specs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add 2 issue templates #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add 2 issue templates #1

wants to merge 2 commits into from

Conversation

gitauto-ai[bot]
Copy link
@gitauto-ai gitauto-ai bot commented Feb 25, 2025 •
edited
Loading

Why is this feature needed?

The GitHub repository currently lacks standardized issue templates, which can lead to inconsistent issue reports and feature requests. By adding these two templates—one for bug reports 8000 and one for feature requests—we aim to streamline and structure the information collected from users, thereby improving issue comprehension and facilitating a faster resolution process.

What and how are we changing? Why this approach?

We are adding two new YAML files in the .github/ISSUE_TEMPLATE directory:

  • bug_report.yml: This template guides users on how to report bugs by specifying fields for bug behavior, logs, screenshots, steps to reproduce, and additional context.
  • feature_request.yml: This template assists users in proposing new features by prompting them to describe the encountered problem, current solution, proposed solution, and any supporting attachments.

Using YAML templates allows GitHub to automatically present users with these forms when they open an issue, ensuring consistency and reducing the information gap between users and maintainers.

What actions are required from users?

End users do not need to take any additional actions. When creating a new issue, they will now see structured choices and fields to correctly report a bug or request a feature. Maintainers and contributors should also review the templates to ensure they align with the current project requirements.

How does it work? (Technical details)

  • The templates are implemented as YAML files in the .github/ISSUE_TEMPLATE directory, which GitHub automatically detects and applies.
  • Each template is pre-populated with required and optional fields to guide users through submitting comprehensive issue reports.
  • Predefined labels (like "bug", "enhancement", and "gitauto") are added to help in categorizing the issues immediately upon creation.

Is it backwards compatible?

Yes, these changes are fully backwards compatible. They only affect the issue creation process on GitHub and will not interfere with any existing workflows or project functionalities.

Any other considerations?

  • The templates are designed to be a starting point. Depending on future feedback, further modifications or additional templates might be required to address other categories of issues.
  • We considered customizations for assignees within the templates (as commented-out code), which can be enabled in the future if needed.
  • This approach also helps maintain a uniform standard for issue reporting that can be beneficial for other contributors in the repository.

@gitauto-ai gitauto-ai bot requested a review from abdulrahman305 February 25, 2025 14:47
@korbit-ai Korbit AI
Copy link
korbit-ai bot commented Feb 25, 2025

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Feb 25, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file. 8519
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abdulrahman305 abdulrahman305 Awaiting requested review from abdulrahman305

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants
0