github.com/consenSys/quorum@v20.10.0+incompatible/.github/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Thank you for your interest in contributing to Quorum!
     4  We welcome 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 quorum please fork, fix, commit and
     8  send a pull request. Commits which do not comply with the coding standards
     9  are ignored.
    10  
    11  ## Coding guidelines
    12  
    13  Please make sure your contributions adhere to our coding guidelines:
    14  
    15   * Code must adhere to the official Go
    16  [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines
    17  (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
    18   * Code must be documented adhering to the official Go
    19  [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
    20   * Pull requests need to be based on and opened against the `master` branch.
    21   * Commit messages should be prefixed with the package(s) they modify.
    22     * E.g. "eth, rpc: make trace configs optional"
    23  
    24  ## Can I have feature X
    25  
    26  Before you submit a feature request, please check and make sure that it isn't
    27  possible through some other means. The JavaScript-enabled console is a powerful
    28  feature in the right hands. Please check our
    29  [developer documentation](https://docs.goquorum.consensys.net/en/latest/) for more info
    30  and help.
    31  
    32  ## Configuration, dependencies, and tests
    33  
    34  Please see the [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
    35  for more details on configuring your environment, managing project dependencies
    36  and testing procedures.