github.com/pygolin/runtime@v0.0.0-20201208210830-a62e3cd39798/CONTRIBUTING.md (about)

     1  Want to contribute? Great! First, read this page.
     2  
     3  ### Before you contribute
     4  Before we can use your code, you must sign the
     5  [Google Individual Contributor License Agreement]
     6  (https://cla.developers.google.com/about/google-individual)
     7  (CLA), which you can do online. The CLA is necessary mainly because you own the
     8  copyright to your changes, even after your contribution becomes part of our
     9  codebase, so we need your permission to use and distribute your code. We also
    10  need to be sure of various other things—for instance that you'll tell us if you
    11  know that your code infringes on other people's patents. You don't have to sign
    12  the CLA until after you've submitted your code for review and a member has
    13  approved it, but you must do it before we can put your code into our codebase.
    14  Before you start working on a larger contribution, you should get in touch with
    15  us first through the issue tracker with your idea so that we can help out and
    16  possibly guide you. Coordinating up front makes it much easier to avoid
    17  frustration later on.
    18  
    19  Contributions made by corporations are covered by a different agreement than
    20  the one above, the
    21  [Software Grant and Corporate Contributor License Agreement]
    22  (https://cla.developers.google.com/about/google-corporate).
    23  
    24  ### Code reviews
    25  All submissions, including submissions by project members, require review. We
    26  use GitHub pull requests for this purpose.
    27  
    28  ### Code Style
    29  We use Google style guides for all our code. Below are the guidelines for each
    30  language we use.
    31  
    32  #### Go
    33  All Go source code must be formatted using gofmt and be lint-clean according to
    34  golint. This will be checked by Travis but can be checked manually from a local
    35  repo via `make gofmt golint`.
    36  
    37  Code is expected to be gofmt- and lint clean before it is submitted for review.
    38  Code reviews can then focus on structural details and higher level style
    39  considerations. Many common mistakes are already documented in the
    40  [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
    41  doc so it's worth being familiar with these patterns.
    42  
    43  #### Python
    44  All Python source code must be lint-clean according to pylint. This will be
    45  checked by Travis but can be checked manually from a local repo via
    46  `make pylint`.
    47  
    48  Once code is pylint-clean, it can be submitted for review. In addition to lint
    49  cleanliness, Python code must adhere to the
    50  [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
    51  which has a number of additional conventions. Please be familiar with the style
    52  guide and ensure code satisfies its rules before submitting for review.
    53  
    54  ##### Borrowed Standard Library Code
    55  Standard library code that is borrowed from other open source projects such as
    56  CPython and PyPy need not be lint clean or satisfy the style guide. The goal
    57  should be to keep the copied sources as close to the originals as possible
    58  while still being functional. For more details about borrowing this kind of
    59  code from other places see the
    60  [guidelines for integration](https://github.com/google/grumpy/wiki/Standard-libraries:-guidelines-for-integration).