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