search

chanzuckerberg / czi-oss-training

Training Materials for Good Open Source Citizenship
Creative Commons Attribution 4.0 International
11 stars 3 forks source link

Discussion - Add contribution guidelines #80

Open trallard opened 1 year ago

trallard commented 1 year ago

Since we released the training materials under a CC-BY license it is important to make it clear whether we accept contributions and how (i.e. the process of contributing and dealing with those contributions)

justinelarsen commented 1 year ago

@trallard Contributions should be welcome.

As for the process, are there any recommendations you suggest? Contributing should be pretty straightforward with instructions for forking the repo, using pre-commit, creating a PR, etc. For dealing with those contributions, I'm not sure who will take care of those going forward. Would you like it to be a joint effort between you, me and some others on both sides like @pavithraes , @k8hertweck , @neuromusic ?

k8hertweck commented 1 year ago

I'm ambivalent about details for the process of contribution. FWIW, here's the contribution guidelines for the website I put together with open science resources (primarily for our grantee community).

I am more opinionated about the approval process for accepting changes. I think CZI should be the one responsible, since the repo is ours, and it's likely most contributions will be minor (typo fixes, adding links, etc). We could say substantive changes in content also represent the opinions of CZI? Or this could be explained via attribution (#70 )

trallard commented 1 year ago

For small changes light contribution processes and approvals should work just fine. And we can share it as a group like @justinelarsen suggests.

This is trickier for large changes such as new sections or modules. In that case we could follow a light enhancement proposal process. That would mean adding an issue template to propose new sections/modules and only move forward with such contribution if the proposal is approved. Then follow standard contribution and attribution processes. This is what the Turing Way does, basically it helps ensure content is aligned with the vision of the project and provides alignment on ownership (i.e. who would write the content).