github.com/dmvolod/operator-sdk@v0.8.2/doc/dev/reporting_bugs.md (about)

     1  # Reporting bugs
     2  
     3  If any part of the operator-sdk project has bugs or documentation mistakes, please let us know by [opening an issue][operator-sdk-issue]. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
     4  
     5  To make the bug report accurate and easy to understand, please try to create bug reports that are:
     6  
     7  - Specific. Include as much details as possible: which version, what environment, what configuration, etc.
     8  
     9  - Reproducible. Include the steps to reproduce the problem. We understand some issues might be hard to reproduce, please include the steps that might lead to the problem.
    10  
    11  - Isolated. Please try to isolate and reproduce the bug with minimum dependencies. It would significantly slow down the speed to fix a bug if too many dependencies are involved in a bug report. Debugging external systems that rely on operator-sdk is out of scope, but we are happy to provide guidance in the right direction or help with using operator-sdk itself.
    12  
    13  - Unique. Do not duplicate existing bug report.
    14  
    15  - Scoped. One bug per report. Do not follow up with another bug inside one report.
    16  
    17  It may be worthwhile to read [Elika Etemad’s article on filing good bug reports][filing-good-bugs] before creating a bug report.
    18  
    19  We might ask for further information to locate a bug. A duplicated bug report will be closed.
    20  
    21  [operator-sdk-issue]: https://github.com/operator-framework/operator-sdk/issues/new
    22  [filing-good-bugs]: http://fantasai.inkedblade.net/style/talks/filing-good-bugs/