...
| What to include in the report? | Good example | Bad example |
|---|---|---|
| Indicate whether you can reproduce the bug reliably or not. | I can reproduce using the following steps:
| Our test fails, here are the logs... |
| Precisely describe which URLs with example payloads to reproduce the issue. | When I send a POST request to http://localhost:8080/ncmp/v1/ch/id-searches with the following JSON: {"cmHandleQueryParameters":[{"conditionName":"hasAllModules","conditionParameters":[{"moduleName":"ietf-yang-types-1"}]}]} | I perform a search for a module |
| Accurately describe the expected and actual results. | Expected Results: The search takes 2 seconds to complete. | It takes a long time |
...
- Clear description of the issue
- Clear Steps to Reproduce
- Affected version(s)
- Expected behavior
- Actual behavior
- Impact - this is important for us to prioritize tickets
- Possible work-arounds
- (Optional) Attached artifacts: Screenshots, Logs, Test data, etc.
- Alternatively, attach the corresponding client-specific Jira or other place where artifacts can be shared.
...