Open philknows opened 1 year ago
Hey @philknows! I'd like to start contributing to lodestar, is this a beginner friendly task to assign myself upon?
Hey @shaansundar! I think docs are generally a great way to start contributing! It'll allow you to document your process and knowledge while learning. Feel free to join our discord and ask any questions in our Lodestar>SSZ channel as you go through it. It's a great way to start learning how Lodestar works.
related to #5961
The goal of these docs are to enable more TypeScript devs to easily learn and experiment with the SSZ library. More tutorials, more detailed docs about usage for the greater community is desired and open for contributions.
Currently, there are some docs located here https://github.com/ChainSafe/lodestar/tree/unstable/packages/types describing the organization of the SSZ library. It should describe basic primary operations such as
serialize
,deserialize
andhashTreeRoot
.Include example usage such as:
Creating and consuming proofs can use additional and clearer examples of usage.
Some of the readme is already located here: https://github.com/ChainSafe/ssz/tree/master/packages/ssz
Additional usage to add: