Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (27 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.14 KB

Contributing

Testing

Testing the vdf and node packages requires linking the native VDF. The test.sh scripts in the respective directories help with this.

Pull Requests

Contributions are welcome – a new network is rife with opportunities. We are in the process of updating our JIRA board so that it can be made public. The repository has basic coding guidelines:

  • 80 character line limit, with the exception where gofmt or the syntax is impossible to achieve otherwise
  • Error wrapping matching function names
  • Interface composition and dependency injection with Wire

Building release binaries

The following software is required to build release binaries (assuming MacOS ARM):

Then from the repo root use the following commands to build the release binaries that statically link the native VDF for the supported platforms:

task build_node_arm64_macos
task build_node_arm64_linux
task build_node_amd64_linux

The output binaries will be in node/build.