sigs.k8s.io/cluster-api-provider-aws@v1.5.5/CONTRIBUTING.md (about)

     1  # Contributing guidelines
     2  
     3  ## Sign the CLA
     4  
     5  Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests.  Please see https://git.k8s.io/community/CLA.md for more info
     6  
     7  ### Contributing A Patch
     8  
     9  1. Submit an issue describing your proposed change to the repo in question.
    10  2. The [repo owners](OWNERS) will respond to your issue promptly.
    11  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
    12  4. Fork the desired repo, develop and test your code changes. 
    13  > See the [developer guide](https://cluster-api-aws.sigs.k8s.io/development/development.html) on how to setup your development environment.
    14  5. Submit a pull request.
    15  
    16  ### Becoming a reviewer
    17  
    18  If you would like to become a reviewer, then please ask one of the maintainers.
    19  There's no hard and defined limit as to who can become a reviewer, but a good
    20  heuristic is 5 or more contributions. A reviewer can get PRs automatically assigned
    21  for review, and can `/lgtm` PRs.
    22  
    23  To become a reviewer, ensure you are a member of the kubernetes-sigs Github organisation
    24  following https://github.com/kubernetes/org/issues/new/choose .
    25  
    26  ### Steps needed to become a maintainer
    27  If you have made significant contributions to Cluster API
    28  Provider AWS, a maintainer may nominate you to become a
    29  maintainer, first by opening a PR to add you to the OWNERS_ALIASES file of the repository.
    30  
    31  Maintainers are able to approve PRs, as well as participate
    32  in release processes.
    33  
    34  Maintainers require membership of the Kubernetes Github organisation via
    35  https://github.com/kubernetes/org/issues/new/choose
    36  
    37  The complete list of tasks required to set up maintainer status
    38  follow:
    39  
    40  * Open PR to add Github username to the OWNERS_ALIASES file under cluster-api-aws-maintainers
    41  * Open PR to add Github username to cluster-api-provider-aws-admins and cluster-api-provider-aws-maintainers
    42  to https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml
    43  * Open PR to add Github username to https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-aws/OWNERS
    44  * Open PR to add Github username to https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-cluster-api-aws/OWNERS
    45  * Open PR to add Google ID to the k8s-infra-staging-cluster-api-aws@kubernetes.io Google group in https://github.com/kubernetes/k8s.io/blob/main/groups/groups.yaml