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

     1  Designs
     2  =======
     3  
     4  These are the design documents for changes to Controller Runtime. They
     5  exist to help document the design processes that go into writing
     6  Controller Runtime, but may not be up-to-date (more below).
     7  
     8  Not all changes to Controller Runtime need a design document -- only major
     9  ones. Use your best judgement.
    10  
    11  When submitting a design document, we encourage having written
    12  a proof-of-concept, and it's perfectly acceptable to submit the
    13  proof-of-concept PR simultaneously with the design document, as the
    14  proof-of-concept process can help iron out wrinkles and can help with the
    15  `Example` section of the template.
    16  
    17  ## Out-of-Date Designs
    18  
    19  **Controller Runtime documentation
    20  [GoDoc](https://pkg.go.dev/sigs.k8s.io/controller-runtime) should be
    21  considered the canonical, update-to-date reference and architectural
    22  documentation** for Controller Runtime.
    23  
    24  However, if you see an out-of-date design document, feel free to submit
    25  a PR marking it as such, and add an addendum linking to issues documenting
    26  why things changed.  For example:
    27  
    28  ```markdown
    29  
    30  # Out of Date
    31  
    32  This change is out of date.  It turns out curly braces are frustrating to
    33  type, so we had to abandon functions entirely, and have users specify
    34  custom functionality using strings of Common LISP instead.  See #000 for
    35  more information.
    36  ```