github.com/dim4egster/coreth@v0.10.2/.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 coreth, 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 guidelines:
    18  
    19   * Code must adhere to the official Go 
    20  [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines 
    21  (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
    22   * Code must be documented adhering to the official Go 
    23  [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
    24   * Pull requests need to be based on and opened against the `master` branch.
    25   * Pull reuqests should include a detailed description
    26   * Commits are required to be signed. See [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
    27   for information on signing commits.
    28   * Commit messages should be prefixed with the package(s) they modify.
    29     * E.g. "eth, rpc: make trace configs optional"
    30  
    31  ## Can I have feature X
    32  
    33  Before you submit a feature request, please check and make sure that it isn't 
    34  possible through some other means.
    35