github.com/jenspinney/cli@v6.42.1-0.20190207184520-7450c600020e+incompatible/.github/PULL_REQUEST_TEMPLATE.md (about)

     1  <!--
     2  If you haven't yet, please review our contributing guidelines: https://github.com/cloudfoundry/cli/blob/master/.github/CONTRIBUTING.md
     3  Please reach out to us on slack or via a Github Issue before making a PR. (Info on where to reach us in the link ^)
     4  Check out our contributions welcome label on GitHub for issues we are actively looking for help on.
     5  -->
     6  
     7  <!--
     8  ## Requirements
     9  
    10  * Your contribution will be analyzed for product fit and engineering quality prior to merging.
    11  If your contribution includes a change that is exposed to cf CLI users (e.g. introducing a new command or flag), please submit an issue to discuss it first.
    12  * We're not allowed to accept any PRs without a signed CLA, no matter how small.
    13  If your contribution falls under a company CLA but your membership is not public, expect delays while we confirm.
    14  * All new code requires tests to protect against regressions.
    15  -->
    16  
    17  ## Does this PR modify CLI v6 or v7?
    18  
    19  <!-- Or perhaps both? Neither?
    20  If you aren't sure what this is referring to, please check out our Architecture Guide: https://github.com/cloudfoundry/cli/wiki/Architecture-Guide -->
    21  
    22  ## What Need Does It Address?
    23  
    24  <!-- What benefits will be realized by the code change? Explain its value to users. What is their current solution to the problem, and why is it insufficient? -->
    25  
    26  ## Who Is The Functionality For?
    27  
    28  <!--
    29  Explain who specifically the change would benefit. What users would want this change? Is there broad demand for the change, or is there a single customer who benefits?
    30  -->
    31  
    32  ## How Often Will This Functionality Be Used?
    33  
    34  <!-- How often will the change be used? -->
    35  
    36  ## Possible Drawbacks
    37  
    38  <!-- What are the possible side-effects or negative impacts of the code change? -->
    39  
    40  ## Why Should This Be In Core?
    41  
    42  <!-- Explain why this functionality should be in the cf CLI, as opposed to a plugin. -->
    43  
    44  ## Description of the Change
    45  
    46  <!--
    47  We must be able to understand the design of your change from this description.
    48  Keep in mind that the maintainer reviewing this PR may not be familiar with or
    49  have worked with the code here recently, so please walk us through the concepts.
    50  -->
    51  
    52  ## Alternate Designs
    53  
    54  <!-- Explain what other alternates were considered and why the proposed version was selected -->
    55  
    56  ## Applicable Issues
    57  
    58  <!-- List any applicable Issues here -->
    59  
    60  ## How Urgent Is The Change?
    61  
    62  <!-- Is the change urgent? If so, explain why it is time-sensitive.-->
    63  
    64  ## Other Relevant Parties
    65  
    66  <!-- Who else is affected by the change? -->