...

Text file src/github.com/ory/fosite/.github/pull_request_template.md

Documentation: github.com/ory/fosite/.github

     1<!--
     2Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
     3
     4This text will be included in the changelog. If applicable, include links to documentation or pieces of code.
     5If your change includes breaking changes please add a codeblock documenting the breaking change:
     6
     7```
     8BREAKING CHANGES: This patch changes the behavior of configuration item `foo` to do bar. To keep the existing
     9behavior please do baz.
    10```
    11-->
    12
    13## Related Issue or Design Document
    14
    15<!--
    16If this pull request
    17
    181. is a fix for a known bug, link the issue where the bug was reported in the format of `#1234`;
    192. is a fix for a previously unknown bug, explain the bug and how to reproduce it in this pull request;
    202. implements a new feature, link the issue containing the design document in the format of `#1234`;
    213. improves the documentation, no issue reference is required.
    22
    23Pull requests introducing new features, which do not have a design document linked are more likely to be rejected and take on average 2-8 weeks longer to
    24get merged.
    25
    26You can discuss changes with maintainers either in the Github Discusssions in this repository or
    27join the [Ory Chat](https://www.ory.sh/chat).
    28-->
    29
    30## Checklist
    31
    32<!--
    33Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
    34them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
    35-->
    36
    37- [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md)
    38      and signed the CLA.
    39- [ ] I have referenced an issue containing the design document if my change
    40      introduces a new feature.
    41- [ ] I have read the [security policy](../security/policy).
    42- [ ] I confirm that this pull request does not address a security
    43      vulnerability. If this pull request addresses a security vulnerability, I
    44      confirm that I got green light (please contact
    45      [security@ory.sh](mailto:security@ory.sh)) from the maintainers to push
    46      the changes.
    47- [ ] I have added tests that prove my fix is effective or that my feature
    48      works.
    49- [ ] I have added necessary documentation within the code base (if
    50      appropriate).
    51
    52## Further comments
    53
    54<!--
    55If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution
    56you did and what alternatives you considered, etc...
    57-->

View as plain text