celestiaorg / smt

A Go library that implements a Sparse Merkle tree for a key-value map.
https://godoc.org/github.com/celestiaorg/smt
MIT License
138 stars 53 forks source link

Add contribution guidelines #38

Open liamsi opened 3 years ago

liamsi commented 3 years ago

Besides the usual foo, clarify which parts of the API are supposed to be non-breaking. Additionally, clarify how contributors can still propose breaking changes (and what increases their chances to land such changes in this library). If there are any relevant specs contributors should be aware of, these should be mentioned in the contribution guidelines, too.

musalbas commented 3 years ago

Any changes that break the tests would probably be breaking the API.

universe2439 commented 1 year ago

Agree