...
Jira server ONAP Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-2055 - Mozilla guide to bug writing: https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html
- Link to new CPS Bug Reporting page: Bug Reporting Guidelines for CPS
Assumptions
<optional, assumptions are like decision made up front ie. everyone agrees on the answer but they are important to mention>
...
| Issue | Notes | Decision | |||||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | Acceptance criteria for bug tickets | What should we do if a bug not reproducible? > Reject | CPS team will decide whether to accept bug ticket based on whether enough information has been provided to be able to reproduce/resolve the issue. | ||||||
| 2 | Standard Bug Reporting Template | The minimal Minimal information needed useful for all bug tickets | 3 | NCMP Bug Reports | There is specific information needed for reproducing NCMP bugs, e.g. number of CM-handles | 4 | Performance Bug Reports | Performance issues are much more difficult to reproduce than functional issues, so may need additional info like heap dumps | Create a wiki page containing bug report template, as a guideline for writing bug report. Fields are optional, depending on context. Daniel Hanrahan will create this page. |
| 35 | Handling of sensitive information such as logs and heap dumps | Need to protect IPR of commercial contributors | Will provide guidelines for what info can/cannot be shared in open source. Client-specific internal Jira ticket can be used to share artifacts, where applicable. | ||||||
| 46 | Bug reporting guidelines | A wiki page showing how to write a good bug report. Note there are many existing ones such as: https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html | Can be done as part of #2 (bug report template) |
<Note. use green for closed issues, yellow for important ones if needed>
...
- Full description of the issue
- Affected version(s)
- Expected behaviour (what is the requirement?)
- Actual behaviour
- Impact - this is important for setting priority
- Steps to reproduce - ideally a Minimal reproducible example
- (Optional) Attached artifacts: Screenshots, Logs, Test data, etc.
...
- Environment
- Attached the corresponding IDUN Jira
There has been much confusion about the number of CM-handles the bug reporters are testing with. In many tickets, phrases such as "80k deployment" is used, but in some cases this was 6k CM-handles, and 20k for others!
...
Performance issues are significantly more difficult to reproduce, being very sensitive the user's deployment/environment.
- Available Environment, including available resources in the deployment (memory and CPU cores, number of application instances)
- What is the load on the system (how many concurrent operations, etc.)?
- Measured CPU and memory consumption
- For Out Of Memory Errors (OOMEs): Attached heap dump - I think this should be a requirement moving forward
...
Client-reported bugs
Links to internal Jira tickets, Jenkins pipelines, should be provided where applicable. Logs etc. could be shared securely herethere.
Acceptance Criteria for Bugs
We need to agree on reasonable criteria, e.g.
- All information in the Bug Reporting Template is provided, especially steps to reproduce
- Bug reporter tests with the latest released version?
- But what do we do when a bug is not reproducible by us?That CPS team has enough information to reproduce the bug
Sharing artifacts such as Logs in the Open Source
...