tweag / cooked-validators

MIT License
39 stars 11 forks source link

Provide a `CONTRIBUTING` file #302

Open Niols opened 1 year ago

Niols commented 1 year ago

WIP; please don't review at this point.

Niols commented 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:

  1. Is this the kind of content you expected from a CONTRIBUTING.md file?
  2. Does the scope seem right to you?
  3. Are there important things that are missing?
  4. Are there things currently in the file that shouldn't be there? (If yes: should they just disappear or go to another file?)

Gabriel mentioned the idea of having a look at Nickel's HACKING.md file and I will be doing that now.

facundominguez commented 1 year ago

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.

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.

facundominguez commented 1 year ago

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.