github.com/devseccon/trivy@v0.47.1-0.20231123133102-bd902a0bd996/docs/community/maintainer/help-wanted.md (about)

     1  # Overview
     2  
     3  We use two labels [help wanted](#help-wanted) and [good first
     4  issue](#good-first-issue) to identify issues that have been specially groomed
     5  for new contributors. The `good first issue` label is a subset of `help wanted`
     6  label, indicating that members have committed to providing extra assistance for
     7  new contributors. All `good first issue` items also have the `help wanted`
     8  label.
     9  
    10  ## Help Wanted
    11  
    12  Items marked with the `help wanted` label need to ensure that they are:
    13  
    14  - **Low Barrier to Entry**
    15  
    16    It should be tractable for new contributors. Documentation on how that type of
    17    change should be made should already exist.
    18  
    19  - **Clear Task**
    20  
    21    The task is agreed upon and does not require further discussions in the
    22    community. Call out if that area of code is untested and requires new
    23    fixtures.
    24  
    25    API / CLI behavior is decided and included in the OP issue, for example: "The
    26    new command syntax is `trivy --format yaml IMAGE_NAME`"_ with
    27    expected validations called out.
    28  
    29  - **Goldilocks priority**
    30  
    31    Not too high that a core contributor should do it, but not too low that it
    32    isn't useful enough for a core contributor to spend time to review it, answer
    33    questions, help get it into a release, etc.
    34  
    35  - **Up-To-Date**
    36  
    37    Often these issues become obsolete and have already been done, are no longer
    38    desired, no longer make sense, have changed priority or difficulty , etc.
    39  
    40  
    41  ## Good First Issue
    42  
    43  Items marked with the `good first issue` label are intended for _first-time
    44  contributors_. It indicates that members will keep an eye out for these pull
    45  requests and shepherd it through our processes.
    46  
    47  These items need to ensure that they follow the guidelines for `help wanted`
    48  labels (above) in addition to meeting the following criteria:
    49  
    50  - **No Barrier to Entry**
    51  
    52    The task is something that a new contributor can tackle without advanced
    53    setup, or domain knowledge.
    54  
    55  - **Solution Explained**
    56  
    57    The recommended solution is clearly described in the issue.
    58  
    59  - **Provides Context**
    60  
    61    If background knowledge is required, this should be explicitly mentioned and a
    62    list of suggested readings included.
    63  
    64  - **Gives Examples**
    65  
    66    Link to examples of similar implementations so new contributors have a
    67    reference guide for their changes.
    68  
    69  - **Identifies Relevant Code**
    70  
    71    The relevant code and tests to be changed should be linked in the issue.
    72  
    73  - **Ready to Test**
    74  
    75    There should be existing tests that can be modified, or existing test cases
    76    fit to be copied. If the area of code doesn't have tests, before labeling the
    77    issue, add a test fixture. This prep often makes a great `help wanted` task!
    78