sigs.k8s.io/gateway-api@v1.0.0/site-src/contributing/enhancement-requests.md (about)

     1  # Enhancement Requests
     2  
     3  Inspired by [Kubernetes enhancements][enhance], Gateway API provides a process for
     4  introducing new functionality or considerable changes to the project. The
     5  enhancement process will evolve over time as the project matures.
     6  
     7  [enhance]: https://github.com/kubernetes/enhancements
     8  
     9  Enhancements provides the basis of a community roadmap. Enhancements may be
    10  filed by anyone, but require approval from a maintainer to accept the
    11  enhancement into the project.
    12  
    13  ## What is Considered an Enhancement?
    14  
    15  An enhancement is generally anything that:
    16  
    17  - Introduces changes to an API.
    18  - Needs significant effort to implement.
    19  - Requires documentation to utilize.
    20  - Impacts how a system is operated including addition or removal of significant
    21    capabilities.
    22  
    23  It is unlikely to require an enhancement if it:
    24  
    25  - Fixes a bug
    26  - Adds more testing
    27  - Code refactors
    28  
    29  If you're unsure the proposed work requires an enhancement, file an issue
    30  and ask.
    31  
    32  ## New Enhancement Process
    33  
    34  The process for creating new enhancement proposals is documented on the
    35  [GEP Overview][gep] page. Please see that page for all the details about how
    36  to log a new GEP, and the process it will follow on its journey towards
    37  Completed status.
    38  
    39  A **documented** discussion of some form **must** exist prior to submitting a
    40  request for enhancement if that enhancement is non-trivial (which we will define
    41  as either: _implicates changes to the API specification_
    42  OR _has some kind of end-user impact_).
    43  
    44  Please use our [Github Discussions][discussion] forum as the initial place to
    45  start, and feel free to bring that discussion up for synchronous conversation in
    46  one of our [community meetings][meetings]. If the created request doesn't
    47  include reference to a discussion and/or recordings of discussion in our
    48  community meetings, please note that it _may_ get closed with a request to
    49  create an initial discussion first.
    50  
    51  [gep]: /geps/overview
    52  [discussion]: https://github.com/kubernetes-sigs/gateway-api/discussions/new/choose
    53  [meetings]: https://gateway-api.sigs.k8s.io/contributing/#meetings
    54  
    55  ## Why are Enhancements Tracked
    56  
    57  As the project evolves, it's important that the community understands how the
    58  enhancement affects the project.  Individually, it's hard to understand how all
    59  parts of the system interact, but as a community we can work together to build
    60  the right design and approach before getting too deep into an implementation.
    61  
    62  ## When to Comment on an Enhancement Issue
    63  
    64  Please comment on the enhancement issue to:
    65  
    66  - Request a review or clarification on the process
    67  - Update status of the enhancement effort
    68  - Link to relevant issues in other repos