Consensys / gnark-crypto

gnark-crypto provides elliptic curve and pairing-based cryptography on BN, BLS12, BLS24 and BW6 curves. It also provides various algorithms (algebra, crypto) of particular interest to zero knowledge proof systems.
Apache License 2.0
495 stars 160 forks source link

Find a way to label and maintain a "maturity" level for packages (experimental... -> audited) #352

Open gbotrel opened 1 year ago

gbotrel commented 1 year ago

Should be consistent with gnark repo.

Some packages are highly experimental, obviously unsecured and subject to drastic changes, while some other are time-tested / audited.

An initial idea (cc @ivokub ) was to force the use of build tags for experimental features + some automated go:generate script to update a table in the README.md + godoc. A draw back is refactoring / ide integration will suffer a bit from that.

gbotrel commented 1 year ago

see also discussion here: https://github.com/golang/go/issues/34409