portmaster
portmaster copied to clipboard
Update report-bug.md to match v1.6.0
I'm surprised that nobody cared to update this, despite all the bugs filed since the location of "Copy Debug Information" has changed.
Summary by CodeRabbit
- Documentation
- Updated bug report instructions to simplify copying debug information.
- For general issues, users now click the ๐ ๏ธ icon in the bottom left followed by "Copy Debug Info."
- For app-related issues, users are guided to navigate via the appโs "Details" tab to locate the "Debugging" section and then select "Copy Debug Information."
๐ Walkthrough
Walkthrough
The pull request updates the bug report template by modifying the instructions provided to users on how to obtain debug information when reporting issues. For general issues, it now directs users to click the ๐ ๏ธ icon in the bottom left and then select "Copy Debug Info" instead of using the previous settings page option. For app-related issues, the steps have been revised to navigate through the appโs Details tab to the Debugging section before copying the debug information. There are no changes to exported or public entities.
Changes
| File | Change Summary |
|---|---|
| .github/ISSUE_TEMPLATE/report-bug.md | Updated instructions for copying debug information: - General issues: Replaced โClick on 'Copy Debug Information' on the Settings pageโ with โClick on the ๐ ๏ธ icon in the bottom left, then 'Copy Debug Info'.โ - App-related issues: Revised navigation steps to reach and copy debug info. |
๐ Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
๐ฅ Commits
Reviewing files that changed from the base of the PR and between 98137ca4b61ed8ba9457dc7c1b0ad4ac8099b11f and 4ae9d989296ffe49105f89e780f47de6729cd3a0.
๐ Files selected for processing (1)
.github/ISSUE_TEMPLATE/report-bug.md(1 hunks)
๐ Additional comments (1)
.github/ISSUE_TEMPLATE/report-bug.md (1)
34-35: Clear and Updated Debug Instructions.
The updated instructions for both general and app-related issues now clearly reflect the new UI flow introduced in v1.6.0. Ensuring users are directed to click the ๐ ๏ธ icon in the bottom left for general issues and to navigate via the app's "Details" tab for app-related issues greatly improves clarity. Please verify that these instructions match the actual in-app behavior.
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?
๐ชง 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.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.