github.com/chenbh/concourse/v6@v6.4.2/.github/pull_request_template.md (about)

     1  <!--
     2  Hi there! Thanks for submitting a pull request to Concourse!
     3  
     4  The title of your pull request will be used to generate the release notes.
     5  Please provide a brief sentence that describes the PR, using the [imperative
     6  mood]. Please refrain from adding prefixes like 'feature:', and don't include a
     7  period at the end.
     8  
     9  Examples: "Add feature to doohickey", "Fix panic during spline reticulation"
    10  
    11  We will edit the title if needed so don't worry about getting it perfect!
    12  
    13  To help us review your PR, please fill in the following information.
    14  -->
    15  
    16  [imperative mood]: https://chris.beams.io/posts/git-commit/#imperative
    17  
    18  ## What does this PR accomplish?
    19  <!--
    20  Choose all that apply.
    21  Also, mention the linked issue here.
    22  This will magically close the issue once the PR is merged.
    23  -->
    24  Bug Fix | Feature | Documentation
    25  
    26  closes # .
    27  
    28  ## Changes proposed by this PR:
    29  <!--
    30  Tell the reviewer What changed, Why, and How were you able to accomplish that?
    31  -->
    32  
    33  ## Notes to reviewer:
    34  <!--
    35  Leave a message to whoever is going to review this PR.
    36  Mainly, pointers to review the PR, and how they can test it.
    37  -->
    38  
    39  ## Release Note
    40  <!--
    41  If needed, you can leave a detailed description here which will be used to
    42  generate the release note for the next version of Concourse. The title of the
    43  PR will also be pulled into the release note.
    44  -->
    45  
    46  ## Contributor Checklist
    47  <!--
    48  Most of the PRs should have the following added to them,
    49  this doesn't apply to all PRs, so it is helpful to tell us what you did.
    50  -->
    51  - [ ] Followed [Code of conduct], [Contributing Guide] & avoided [Anti-patterns]
    52  - [ ] [Signed] all commits
    53  - [ ] Added tests (Unit and/or Integration)
    54  - [ ] Updated [Documentation]
    55  - [ ] Added release note (Optional)
    56  
    57  [Code of Conduct]: https://github.com/concourse/concourse/blob/master/CODE_OF_CONDUCT.md
    58  [Contributing Guide]: https://github.com/concourse/concourse/blob/master/CONTRIBUTING.md
    59  [Anti-patterns]: https://github.com/concourse/concourse/wiki/Anti-Patterns
    60  [Signed]: https://help.github.com/en/github/authenticating-to-github/signing-commits
    61  [Documentation]: https://github.com/concourse/docs
    62  
    63  ## Reviewer Checklist
    64  <!--
    65  This section is intended for the reviewers only, to track review
    66  progress.
    67  -->
    68  - [ ] Code reviewed
    69  - [ ] Tests reviewed
    70  - [ ] Documentation reviewed
    71  - [ ] Release notes reviewed
    72  - [ ] PR acceptance performed
    73  - [ ] New config flags added? Ensure that they are added to the
    74    [BOSH](https://github.com/concourse/concourse-bosh-release) and
    75    [Helm](https://github.com/concourse/helm) packaging; otherwise, ignored for
    76    the [integration
    77    tests](https://github.com/concourse/ci/tree/master/tasks/scripts/check-distribution-env)
    78    (for example, if they are Garden configs that are not displayed in the
    79    `--help` text).