Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a CONTRIBUTING file #302

Merged
merged 13 commits into from
Jul 29, 2024
Merged

Provide a CONTRIBUTING file #302

merged 13 commits into from
Jul 29, 2024

Conversation

Niols
Copy link
Member

@Niols Niols commented Feb 27, 2023

WIP; please don't review at this point.

@Niols Niols self-assigned this Feb 27, 2023
@Niols Niols force-pushed the contributing branch 2 times, most recently from 2d9dc87 to db384c3 Compare February 27, 2023 15:56
@Niols
Copy link
Member Author

Niols commented Feb 27, 2023

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
Copy link
Member

facundominguez commented Feb 27, 2023

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.

  • Welcome issues and pull requests.
  • Explain that issues are a good way to reach maintainers with questions.
  • Explain how to build and test patches ahead of submitting PRs.
  • Maybe examples in 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.

@Niols Niols force-pushed the contributing branch 2 times, most recently from 6b868ab to 6355396 Compare February 28, 2023 17:34
@facundominguez
Copy link
Member

facundominguez commented Mar 1, 2023

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.

@mmontin mmontin marked this pull request as ready for review July 29, 2024 10:28
@mmontin mmontin merged commit bfd69c6 into main Jul 29, 2024
7 checks passed
@mmontin mmontin deleted the contributing branch July 29, 2024 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants