Update Issue Template for Test Reports
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 2.9k
- Forks
- 339
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 52
Description
Description
This is a request to update the internal issue template for test reports. The current template contains several required and optional fields that need to be filled out when reporting a test issue.
Environment
Note: This is a meta-issue about the template itself. Specific version information should be provided when an actual test issue is reported.
Template Field Details & Mapping
The following outlines the fields in the current template and their purpose:
Version Information (Required)
- Please provide the output of
bin/observer -V. - If the test also involves a version change for OBPROXY, please also provide the output of
obproxy -V.
Is this a temporary version provided by an RD?
- Options: No / Provided temporarily by [xxx]
Reproduction Difficulty
- Options: Always reproducible / Intermittent / Uncertain / Other
Test Change Details
- Describe any changes made for testing (e.g., added a new test scenario, used new machines, ran a new tool, issue appeared after replacing with a new version).
Were there other abnormalities or changes in the environment?
- Options: No / Clog disk was full / Manual operations performed (e.g., ...) / Injected exception [xx]
Scenario Description / Steps to Reproduce (Required)
- Please fill this out carefully. Describe the workload run on the environment, actions taken before the problem occurred, and any test changes.
- Strongly discourage only posting ERROR logs or stack traces without context!
- For reproducing SQL, please upload it as an attachment whenever possible.
Environment Information
- Please provide connection strings for the problematic tenant and the sys tenant, as well as deployment information.
- Indicate if the scene has been preserved.
Log Information
(Field for attaching relevant logs)
Other
- For issues reported by external business teams, please correctly select the "Work Item Type" on the right based on the actual situation:
- Customer Service Feedback: Specifically refers to issues before production deployment or during POC, where a product bug is confirmed and requires a fix and release.
- Online Issue: An issue that occurred after production deployment, confirmed as a product bug, but not classified as a fault.
- Online Fault: An issue that occurred after production deployment, confirmed as a product bug, which has caused business errors or public impact on the customer side. (The final classification as a fault is determined by the delivery service team.)
Mapping of Right-side Properties
- There is a mapping relationship between the "Target Branch" property and the "Iteration" property on the right side of the form.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the current issue template for test reports and compare its fields with the requested version, environment, reproduction, scenario, log, and work-item mappings. Update the template so these details and required guidance are represented, then verify that the rendered form contains the requested fields and options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 60/100