github.com/consensys/gnark-crypto@v0.14.0/.github/pull_request_template.md (about)

     1  # Description
     2  
     3  Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
     4  Note that in most cases the PR should be against the `develop` branch.
     5  
     6  Fixes # (issue)
     7  
     8  ## Type of change
     9  
    10  Please delete options that are not relevant.
    11  
    12  - [ ] Bug fix (non-breaking change which fixes an issue)
    13  - [ ] New feature (non-breaking change which adds functionality)
    14  - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
    15  - [ ] This change requires a documentation update
    16  
    17  # How has this been tested?
    18  
    19  Please describe the tests that you ran or implemented to verify your changes. Provide instructions so we can reproduce.
    20  
    21  - [ ] Test A
    22  - [ ] Test B
    23  
    24  # How has this been benchmarked?
    25  
    26  Please describe the benchmarks that you ran to verify your changes.
    27  
    28  - [ ] Benchmark A, on Macbook pro M1, 32GB RAM
    29  - [ ] Benchmark B, on x86 Intel xxx, 16GB RAM
    30  
    31  # Checklist:
    32  
    33  - [ ] I have performed a self-review of my code
    34  - [ ] I have commented my code, particularly in hard-to-understand areas
    35  - [ ] I have made corresponding changes to the documentation
    36  - [ ] I have added tests that prove my fix is effective or that my feature works
    37  - [ ] I did not modify files generated from templates
    38  - [ ] `golangci-lint` does not output errors locally
    39  - [ ] New and existing unit tests pass locally with my changes
    40  - [ ] Any dependent changes have been merged and published in downstream modules
    41