github.com/theQRL/go-zond@v0.1.1/.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 go-zond, 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 [our discussion page](https://github.com/theQRL/go-zond/discussions) 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   * Commit messages should be prefixed with the package(s) they modify.
    26     * E.g. "eth, rpc: make trace configs optional"
    27  
    28  ## Can I have feature X
    29  
    30  Before you submit a feature request, please check and make sure that it isn't 
    31  possible through some other means. The JavaScript-enabled console is a powerful 
    32  feature in the right hands. Please see the upstream 
    33  [Geth documentation page](https://geth.ethereum.org/docs/) for more info
    34  and help.
    35  
    36  ## Configuration, dependencies, and tests
    37  
    38  Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/geth-developer/dev-guide)
    39  to get started on configuring your environment, managing project dependencies
    40  and testing procedures: much of this carries over to go-zond.  Use our [Discussion page](https://github.com/theQRL/go-zond/discussions) if you have any questions.