Update Issue Templates: Add Feature Request Template and Improve Issue Submission Process #580
Conversation
WalkthroughThis update enhances the GitHub repository's issue tracking by introducing a new configuration for issue templates. It disables blank issue creation and includes contact links for user resources, including a Bug Bounty program and documentation. Additionally, a structured feature request template is added to streamline submissions, ensuring users provide essential information while promoting engagement and clarity in communication. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/ISSUE_TEMPLATE/config.yml (1 hunks)
- .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
Additional comments not posted (10)
.github/ISSUE_TEMPLATE/config.yml (2)
1-1: LGTM! Disabling blank issues is a good practice.Setting
blank_issues_enabledtofalseencourages more structured and informative issue reports.
2-11: LGTM! Contact links provide valuable resources.The contact links for the Bug Bounty program, Safety CLI Documentation, and User Survey are well-organized and provide users with easy access to important resources.
.github/ISSUE_TEMPLATE/feature_request.yml (8)
1-3: LGTM! Feature request metadata is clear and concise.The name, description, and labels for the feature request template are appropriate and help categorize the issue correctly.
5-9: LGTM! Friendly introduction encourages detailed submissions.The introductory markdown message is welcoming and sets a positive tone for users submitting feature requests.
11-18: LGTM! Checklist ensures compliance with guidelines.Requiring agreement to the Safety Code of Conduct helps maintain a respectful and collaborative environment.
19-27: LGTM! Safety version field captures essential information.Requiring the Safety version helps in diagnosing issues specific to certain versions.
28-36: LGTM! Python version field is necessary for compatibility.Requiring the Python version helps identify compatibility issues with different Python versions.
37-45: LGTM! Operating System field captures environment details.Requiring the Operating System helps in diagnosing issues that may be specific to certain environments.
46-54: LGTM! Problem description field ensures clarity.Requiring a detailed problem description helps in understanding the user's needs and challenges.
55-86: LGTM! Solution and context fields promote comprehensive submissions.The fields for describing the ideal solution, alternatives, additional context, and user actions are well-structured and facilitate thorough evaluation of feature requests.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/ISSUE_TEMPLATE/config.yml (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/config.yml
This PR introduces significant improvements to the issue submission process for the Safety CLI repository by implementing a structured and user-friendly approach to reporting issues and feature requests. The following changes have been made:
1. Deleted
.github/ISSUE_TEMPLATE.md:* Removed the old issue template, which included fields such as:
* Safety version
* Python version
* Operating System
* Description
* What I Did
* This template has been replaced by a more modern and organized approach with separate templates.
2. Added
.github/ISSUE_TEMPLATE/config.yml:* Disabled blank issues by setting blank_issues_enabled: false to encourage more structured issue reporting.
* Added contact links for Bug Bounty, Safety CLI Documentation, and a User Survey:
* Bug Bounty: Link to Safety CLI Documentation
* Documentation: Link to Safety CLI Documentation
* Survey: Link to Safety CLI Survey- This survey is not yet added but should be either added in or this bullet removed before merge!
3. Added
.github/ISSUE_TEMPLATE/feature_request.yml:* Created a dedicated template for feature requests with fields to ensure all necessary information is captured:
* Checklist: Agreement to the Safety Code of Conduct
* Safety version: Required field to specify the version of Safety CLI being used.
* Python version: Required field to specify the version of Python.
* Operating System: Required field to specify the OS.
* Describe the problem: A clear and concise description of the problem to be solved.
* Describe the ideal solution: A clear and concise description of the proposed solution.
* Alternatives and current workarounds: Optional field for alternative solutions or workarounds.
* Additional context: Optional field for any other relevant information or screenshots.
* What I Did: A detailed description of the steps taken, including commands run and output (if applicable).
These changes aim to streamline the issue reporting process, making it easier for users to submit well-structured and informative feature requests, ultimately enhancing the overall quality and efficiency of issue management in the Safety CLI project.
Summary by CodeRabbit