github.com/anchore/syft@v1.38.2/.github/pull_request_template.md (about)

     1  # Description
     2  
     3  Please include a summary of the changes along with any relevant motivation and context,
     4  or link to an issue where this is explained.
     5  
     6  <!-- If this completes an issue, please include: -->
     7  
     8  - Fixes
     9  
    10  ## Type of change
    11  
    12  <!-- Delete any that are not relevant -->
    13  
    14  - [ ] Bug fix (non-breaking change which fixes an issue)
    15  - [ ] New feature (non-breaking change which adds functionality)
    16  - [ ] Breaking change (please discuss with the team first; Syft is 1.0 software and we won't accept breaking changes without going to 2.0)
    17  - [ ] Documentation (updates the documentation)
    18  - [ ] Chore (improve the developer experience, fix a test flake, etc, without changing the visible behavior of Syft)
    19  - [ ] Performance (make Syft run faster or use less memory, without changing visible behavior much)
    20  
    21  # Checklist:
    22  
    23  - [ ] I have added unit tests that cover changed behavior
    24  - [ ] I have tested my code in common scenarios and confirmed there are no regressions
    25  - [ ] I have added comments to my code, particularly in hard-to-understand sections