chore(docs): Update bug-report.yml #28
Conversation
WalkthroughThe pull request modifies the bug report template in the GitHub repository to improve clarity and detail in the information requested from users. Key changes include expanded introductory messages, renamed sections, and the introduction of new placeholders for various system and configuration details. Specific sections have been refined to guide users in providing comprehensive information about their environment, steps to reproduce issues, expected vs. actual results, and relevant logs. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Template
User->>Template: Fill out bug report
Template-->>User: Request detailed information
User->>Template: Provide system info, steps to reproduce, logs
Template-->>User: Confirm submission
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 (
|
yarikbratashchuk
requested review from
tzdybal,
gupadhyaya and
Manav-Aggarwal
![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
🧹 Outside diff range and nitpick comments (7)
.github/ISSUE_TEMPLATE/bug-report.yml (7)
15-15: Fix trailing whitespace.Remove the trailing space after
Git SHA:to comply with YAML formatting standards.- Git SHA: + Git SHA:🧰 Tools
🪛 GitHub Check: yamllint
[failure] 15-15:
15:17 [trailing-spaces] trailing spaces🪛 yamllint
[error] 15-15: trailing spaces
(trailing-spaces)
15-21: Consider clarifying Git SHA format.To help users provide the correct information, consider adding an example format for the Git SHA.
- Git SHA: + Git SHA (full 40-character hash):🧰 Tools
🪛 GitHub Check: yamllint
[failure] 15-15:
15:17 [trailing-spaces] trailing spaces🪛 yamllint
[error] 15-15: trailing spaces
(trailing-spaces)
38-39: Consider adding format examples for memory and disk space.To ensure consistent reporting, consider adding example formats for memory and disk space values.
- Memory Size: - Available Disk Space: + Memory Size (e.g., 16GB): + Available Disk Space (e.g., 500GB):
42-53: Consider making Network Configuration required.Given the distributed nature of the system, network configuration details are often crucial for debugging issues.
P2P Port: RPC Port: + validations: + required: true
60-62: Consider adding version format examples.To ensure consistent reporting, consider adding example version formats.
- Docker Version: - Docker Compose Version: - Make Version: + Docker Version (e.g., 20.10.21): + Docker Compose Version (e.g., 2.12.2): + Make Version (e.g., 4.3):
82-83: Consider adding environment setup guidance.To ensure reproducibility, consider adding more specific guidance about environment setup.
- 1. Initial setup steps + 1. Initial setup steps (include fresh install vs existing environment)
114-121: Consider adding log format guidance.To improve log readability and processing, consider adding specific format requirements.
- System logs - Max 20 lines per component or provide gist/pastebin links + Max 20 lines per component or provide gist/pastebin links + Format: Include timestamps and log levels where available + Example: [2024-01-01 10:00:00] [ERROR] message
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug-report.yml(1 hunks)
🧰 Additional context used
🪛 GitHub Check: yamllint
.github/ISSUE_TEMPLATE/bug-report.yml
[failure] 15-15:
15:17 [trailing-spaces] trailing spaces
🪛 yamllint
.github/ISSUE_TEMPLATE/bug-report.yml
[error] 15-15: trailing spaces
(trailing-spaces)
🔇 Additional comments (4)
.github/ISSUE_TEMPLATE/bug-report.yml (4)
8-8: LGTM! Clear and welcoming introduction message.
The message effectively encourages users to provide detailed information while maintaining a friendly tone.
67-76: LGTM! Comprehensive configuration details section.
The section effectively captures various configuration aspects that could affect system behavior.
93-107: LGTM! Clear structure for expected and actual results.
The sections effectively guide users in providing clear comparisons between expected and actual behavior.
126-133: LGTM! Comprehensive additional information section.
The section effectively captures various additional details that could be relevant for debugging.
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
.github/ISSUE_TEMPLATE/bug-report.yml (5)
8-8: Enhance the introduction message with template guidance.Consider expanding the introduction to emphasize the importance of following the template structure.
- Thank you for filling out this bug report! Please provide as much detail as possible to help us investigate. + Thank you for filling out this bug report! To help us investigate effectively: + - Please provide as much detail as possible + - Fill out all relevant sections of this template + - Use code blocks for logs and commands
31-38: Add additional system metrics for comprehensive debugging.Consider adding these important system metrics to help diagnose performance-related issues:
OS Type & Version: Architecture (arm64/amd64): Kernel Version (for Linux): + CPU Model & Cores: Memory Size: + Swap Space: Available Disk Space: + System Load Average:
41-52: Include network security and performance metrics.Consider adding these network-related fields to help diagnose connectivity and security issues:
Network Type (Testnet/Mainnet): Network ID: Chain ID: Connected Peers: P2P Port: RPC Port: + SSL/TLS Configuration: + Firewall Rules (if relevant): + Network Latency (ping times): + Bandwidth Limitations:
83-90: Add version control context and reproducibility information.Consider adding these fields to help with issue reproduction:
1. Initial setup steps + 2. Git branch and commit hash + 3. Clean environment confirmation 2. Commands executed 3. API calls made 4. Expected trigger points 5. Error occurrence timing + 6. How often is this reproducible? (e.g., 100%, intermittent)
130-137: Add documentation references and environment comparisons.Consider adding these fields to provide additional context:
- Alternative reproduction methods - Related issues - Recent system changes - Workarounds attempted - Impact severity + - Relevant documentation links + - Does this work in a different environment? (e.g., local vs. staging)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug-report.yml(1 hunks)
🔇 Additional comments (5)
.github/ISSUE_TEMPLATE/bug-report.yml (5)
12-21: Implementation matches previous review suggestions.
56-66: Implementation expands upon previous review suggestions appropriately.
70-79: Implementation expands upon previous review suggestions appropriately.
96-110: Well-structured result sections with clear guidance.
The expected and actual result sections provide comprehensive guidance for users to describe behaviors and outcomes.
116-125: Implementation expands upon previous review suggestions appropriately.
Overview
Summary by CodeRabbit
New Features
Improvements