Add 2 issue templates - #1
Conversation
Reviewer's Guide by SourceryThis pull request introduces two new issue templates: a bug report template and a feature request template. These templates are designed to streamline the process of creating issues by providing clear guidelines and fields for reporters to fill out. Class diagram for issue templates structureclassDiagram
class IssueTemplate {
+String name
+String description
+String title
+String[] labels
}
class BugReport {
+String bugBehavior
+String logs
+String screenshots
+String whenItOccurred
+String stepsToReproduce
+String expectedBehavior
+String possibleCause
+String device
+String os
+String browser
+String additionalInformation
}
class FeatureRequest {
+String problem
+String currentSolution
+String proposedSolution
+String attachments
+String additionalInformation
}
IssueTemplate <|-- BugReport
IssueTemplate <|-- FeatureRequest
note for BugReport "Detailed template for reporting bugs"
note for FeatureRequest "Template for suggesting new features"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![reviewabot[bot]](https://avatars.githubusercontent.com/in/1023405?s=60&v=4){kind=small}
There was a problem hiding this comment.
The pull request looks good overall, but there are a few points that need attention:
-
Consecutive Line Breaks: There are no unnecessary consecutive line breaks, which is good. However, ensure that the formatting remains consistent and clean.
-
Naming Conventions: The naming of the IDs and labels is clear and descriptive, which is good for readability.
-
Security Issues: There are no secrets or sensitive information in clear text, which is good.
-
Missing Newline at End of File: Both files should end with a newline. This is a common convention in many codebases to avoid issues with concatenation and version control systems. Ensure that the files end with a newline.
-
Commented Out Code: The
assigneesfield is commented out in both templates. If it's not needed, it should be removed entirely to keep the code clean. If it might be used in the future, consider adding a comment explaining why it's commented out. -
Placeholder Values: The placeholder values are clear and provide good examples. However, ensure that they are kept up-to-date with any changes in the system or application.
-
Consistency in Descriptions: Ensure that the descriptions are consistent in tone and style across both templates.
-
Validation Requirements: The validation requirements are appropriate and ensure that necessary information is collected.
Please address the missing newline at the end of the files and consider the other points for maintaining clean and readable code.
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 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 (
|
Overview
This PR adds issue templates to the repository so that you can create issues more easily for GitAuto and your project. Please review the changes and merge the PR if you agree.
Added templates:
Summary by Sourcery
Chores: