-
-
Notifications
You must be signed in to change notification settings - Fork 71
Add GitHub Issue Templates (Bug, Feature, Task) #871
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.
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
base: main
Are you sure you want to change the base?
Conversation
Add GitHub issue templates: bug, feature, task
|
Thanks for your first pull request! We appreciate your contribution. |
Summary of ChangesHello @HITMAN5050, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's issue management by introducing a set of structured GitHub Issue Templates. The primary goal is to improve the quality and clarity of incoming issues, making it easier for maintainers to understand, prioritize, and address community contributions. By providing clear guidance for bug reports, feature requests, and general tasks, this change streamlines the contribution process and fosters a more organized development workflow. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with π and π on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Here's the code health analysis summary for commits Analysis Summary
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a set of GitHub issue templates for bug reports, feature requests, and tasks, which is a great step towards more structured issue reporting. The templates are well-defined, and disabling blank issues is a good practice. I've identified a couple of areas for improvement: one in the config.yml to fix a potentially broken link, and another in the task.md template to make the labels more flexible and consistent with the other templates. Overall, this is a valuable addition to the repository.
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Contribution guide | ||
| url: /CONTRIBUTING.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The url for a contact link must be a full URL, including the protocol (e.g., https://). The current relative path /CONTRIBUTING.md will resolve to https://github.com/CONTRIBUTING.md, which is a broken link. Please update this to the full URL of the CONTRIBUTING.md file in this repository's default branch. For example: https://github.com/<owner>/<repo>/blob/main/CONTRIBUTING.md.
| --- | ||
| name: Task | ||
| about: Small task or documentation update. | ||
| labels: documentation, low-priority |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The labels documentation and low-priority might be too restrictive for this template. The template is for any "Small task or documentation update," but a task might not be related to documentation or could be of higher priority. To allow for more flexibility and to maintain consistency with the other issue templates, consider using a more generic task label and adding needs-triage so that priority and other relevant labels can be assigned during the triage process.
| labels: documentation, low-priority | |
| labels: task, needs-triage |
|
Hello @jbampton Sir , I did't change any of other base code , but i am confuse if i not change any code then why this error comming ? |
|
Hey @HITMAN5050 the failing tests are unrelated to your work. |
Summary
This PR adds three new GitHub Issue Templates to help contributors file clear and structured issues.
Templates Added
bug_report.mdβ for reporting bugs with steps to reproducefeature_request.mdβ for suggesting improvements or new featurestask.mdβ for small documentation or maintenance tasksPreview
After merging, when users click "New Issue", they will see three choices:
Checklist
.github/ISSUE_TEMPLATE/Notes
Happy to make changes if maintainers suggest improvements!
@jbampton Please review when you get a chance π