github.com/MetalBlockchain/subnet-evm@v0.4.9/.github/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Thank you for considering to help out with the source code! We welcome
     4  contributions from anyone on the internet, and are grateful for even the
     5  smallest of fixes!
     6  
     7  If you'd like to contribute to subnet-evm, please fork, fix, commit and send a
     8  pull request for the maintainers to review and merge into the main code base. If
     9  you wish to submit more complex changes though, please check up with the core
    10  devs first on [Discord](https://chat.avalabs.org) to
    11  ensure those changes are in line with the general philosophy of the project
    12  and/or get some early feedback which can make both your efforts much lighter as
    13  well as our review and merge procedures quick and simple.
    14  
    15  ## Coding guidelines
    16  
    17  Please make sure your contributions adhere to our coding and documentation
    18  guidelines:
    19  
    20  - Code must adhere to the official Go
    21    [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines
    22    (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
    23  - Pull requests need to be based on and opened against the `master` branch.
    24  - Pull reuqests should include a detailed description
    25  - Commits are required to be signed. See [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
    26    for information on signing commits.
    27  - Commit messages should be prefixed with the package(s) they modify.
    28    - E.g. "eth, rpc: make trace configs optional"
    29  
    30  ## Documentation guidelines
    31  
    32  - Code should be well commented, so it is easier to read and maintain.
    33   Any complex sections or invariants should be documented explicitly.
    34  - Code must be documented adhering to the official Go
    35    [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
    36  - Changes with user facing impact (e.g., addition or modification of flags and
    37   options) should be accompanied by a link to a pull request to the [metal-docs](https://github.com/MetalBlockchain/metal-docs)
    38   repository.
    39  - Changes that modify a package significantly or add new features should
    40   either update the existing or include a new `README.md` file in that package.
    41  
    42  ## Can I have feature X
    43  
    44  Before you submit a feature request, please check and make sure that it isn't
    45  possible through some other means.