Open Niols opened 1 year ago
I find it hard to start a review process on such a file. For now, I have been hacking something based on Mozilla Science Lab's guidelines to write a CONTRIBUTING file that in particular refers to Atom's CONTRIBUTING.md. In a first round of reviews, I would like to ask the following questions to a reviewer:
CONTRIBUTING.md
file?Gabriel mentioned the idea of having a look at Nickel's HACKING.md file and I will be doing that now.
Here's how GHC does it: https://gitlab.haskell.org/ghc/ghc/-/blob/master/HACKING.md
For cooked, I'd keep it lean in the beginning.
cooked-smart-contracts
need to be tested as well (?).Then it would make sense to add other things as the need arises.
The Atom guide is too big of an example, I'd say.
I found today the contributing file from plutus-apps: https://github.com/input-output-hk/plutus-apps/blob/main/CONTRIBUTING.adoc
I share it not to imitate, but because it may surface details that people here consider relevant.
WIP; please don't review at this point.