sigs.k8s.io/controller-runtime@v0.18.2/designs/template.md (about)

     1  Title of the Design
     2  ===================
     3  
     4  <!-- Describe your change here.  This is purposefully freeform: we want
     5  enough information to evaluate the design, but not so much that you're
     6  annoyed by the overall design process and decide to bake cookies instead.
     7  -->
     8  
     9  ## Example
    10  
    11  <!-- Specify an example of how the user would use this.  It helps other
    12  contributors get a feel for how this will look in real code, and provides
    13  a good opportunity to evaluate the end-user feel of the code for yourself.
    14  
    15  If you find yourself groaning at verbosity, copy-and-pasting a lot, or
    16  writing a bunch of tiny helper functions, it's a good indication that you
    17  might need to re-evaluate the user experience of your design.
    18  
    19  This is also a good opportunity to stop and write a proof-of-concept, if
    20  you haven't already, which should help catch practical nits with the
    21  design. -->