coral-xyz/sealevel-attacks

Missing documentation for examples

yourarj opened this issue · 3 comments

yourarj commented

@armaniferrante we should add one/two liner comments or doc comments on every example

explaining
unsafe - why it's unsafe
recommended - why this practice is recommended
secure - why it's secure.

It'll definitely help new repo visitor understand the moto behind the different approaches and will help get deeper understanding overall.

yourarj commented

@armaniferrante I've attempted this here
yourarj@c2788df

Please have a look at the above example commit, if that seems fine. May be I can pick it up from there on and document other cases too.

yourarj commented

Or maybe we can add a README.md in every example about the recommended practice (theory). The motivation is to get reader a clear idea about what is that we are trying to achieve and what approach we are taking

  • ❤️1
oslfmt commented

Man, this would be absolutely awesome