Adding Bug Report Guide#1292
Conversation
github-actions
Bot
added
documentation
ajemory
force-pushed
the
issue-required-info
branch
from
eacb893 to
7b86268
Compare
dcantah
left a comment
dcantah
left a comment
There was a problem hiding this comment.
LGTM after the one spelling mistake
jglogan
left a comment
jglogan
left a comment
There was a problem hiding this comment.
Made some suggestions for alternatives on the form, and the location of the bug report doc.
| attributes: | ||
| label: Expected behavior | ||
| description: A concise description of what you expected to happen. | ||
| description: | |
There was a problem hiding this comment.
This can be included in the repro description.
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
| description: | |
There was a problem hiding this comment.
I'd prefer to get rid of this field, and that reporters put log output in code blocks, or uploaded log files, in the description and/or repro sections.
This problem with shell here is that if you need to include multiple log snippets, or want to upload files, your not putting logs here anyway.
| @@ -0,0 +1,179 @@ | |||
| # How to File Effective Bug Reports | |||
There was a problem hiding this comment.
Consider moving this into a section in https://github.com/applecontainerization/CONTRIBUTING.md.
All our other contributor information is there.
There was a problem hiding this comment.
nit: all the headers should be updated to follow sentence casing if this will be moved?
There was a problem hiding this comment.
Consider moving this into a section in https://github.com/applecontainerization/CONTRIBUTING.md.
Changed my mind on this, Let's leave it here as this is about details for filing container issues.
A @saehejkang mentions, all of our headings should use sentence case, not title case.
| ### Writing Good Reproduction Steps | ||
| - Be specific about your setup and the commands you run | ||
| - Include any configuration changes | ||
| - Mention if steps work differently on different systems |
There was a problem hiding this comment.
This is mostly already covered in the section above right?
| - Official documentation | ||
| - Previous working versions | ||
| - Logical expectations based on the command or action |
There was a problem hiding this comment.
I feel like this is also covered by the section immediately above it
| ``` | ||
|
|
||
| ### Container CLI Version | ||
| Check your Container CLI version (if you are on main, you can just put main): |
There was a problem hiding this comment.
I think we should remove the part about if you're on main. If the issue hasn't been looked at in a while it will be hard to find what actual version they were using. Plus the --version output should include the short hash of the commit. Thoughts?
|
|
||
| Example output: | ||
| ``` | ||
| container CLI version 0.10.0.1 (build: release, commit: 1abc234) |
There was a problem hiding this comment.
Typo here for the CLI version example?
| - Combine flags for maximum information: | ||
| ```bash | ||
| container logs --debug --follow <container-name> | ||
| ``` |
There was a problem hiding this comment.
I think we should either remove this or reword the bullet point. Right now it kind of reads like if I use the debug and follow flag, I'd be getting additional logs that I would not otherwise get from just running with the debug flag.
| - Related warning messages | ||
|
|
||
| ### Environment Variations | ||
| - Does it work with a fresh container? |
There was a problem hiding this comment.
By this do we mean a fresh install of the package or a fresh run of a given instance of a container itself?
| container logs <container-name> | ||
| ``` | ||
|
|
||
| #### Useful Log Flags |
There was a problem hiding this comment.
I'm wondering if we should just link to the command-reference.md for this section and the Useful System Log Options section
ajemory
force-pushed
the
issue-required-info
branch
from
0599309 to
89eebfd
Compare
ajemory
force-pushed
the
issue-required-info
branch
from
7f4baad to
0ac24be
Compare
5 participants
Type of Change
Motivation and Context
Adding help guide to bug report template to make it easier for users to include relevant information
Testing