smeb_y/ceremonyclient
1
0
Fork 0
mirror of https://source.quilibrium.com/quilibrium/ceremonyclient.git synced 2024-12-26 00:25:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
bc49a02a02
ceremonyclient/CONTRIBUTING.md
Agost Biro bc49a02a02
Fix docs and release build commands
2024-06-08 13:07:00 +02:00

1.1 KiB
Raw Blame History

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.