Proposal for Community Health Files

[vsoch]

This repository will serve as a base for community health files, including (but not limited to) those described here, namely:

• CODE_OF_CONDUCT.md
• SECURITY.md
• CONTRIBUTING.md
• SUPPORT.md
• PULL_REQUEST_TEMPLATE.md
• ISSUE_TEMPLATE_x.md
• (funding.yml) ?

The general idea is that any repository under the sourcecred organization that doesn't have these files will (based on the documentation) inherit those here. If a downstream repository wants to override the files here, that works too. What I'd like to do is lay out my early plan for creating and getting feedback on these files in this issue, and then get others feedback before moving forward.

Plan of Action

Step 1: Base Community Files

For each bullet above, I'll open a separate pull request to just focus on the file in the docs repository. This is a subtle detail, but as @decentralion pointed out, it's less confusing to have them all in one spot, and we will have automation (GitHub workflows) to sync changes here. I will err on the side of choosing well known, simple templates for each, and then getting robust feedback from the community about if it's a good choice, and how to modify or tweak to make it better. We should (I think) have each pull request open for at least two weeks to give everyone suitable time to respond.

That's the level of detail I'll put here for now, please leave comments / feedback on anything you'd like done differently, and give a 👍 on this issue when you approve and I can move forward with the pull requests.

Step 2: Documentation Template

Step 2 lines up with the Phase II outlined here and namely, it means designing a site and organization for files in the sourcecred/docs repository. @s-ben designing static docs is one of my favorite things to do so I want to offer myself as a work horse for it (errr, work dinosaur?) :P and importantly, it's relevant here because we will have community health docs rendering in programmatically.

Step 3: Automation

For the last step, we should open up a new discussion about how we want the two docs bases (here and docs) to be linked to one another, and to discord / discourse. This should be fun too, because it means automation, and the effort is to ensure that everyone can be maximally involved and it's not totally biased toward GitHub. The end goal will be to update all docs at sourcecred/docs and have specific files pushed here, and always to include other platform for any changes to be discussed.

I'll open an issue on discourse asap to share this issue! Let the documentation fun begin (err, continue) :O) !

[teamdandelion]

Per the discussion on this thread -- can we do the review + development of the documentation in the /docs repository, and then just mirror them into this repo? I like the idea of having a single source of truth for docs (and many of these guidelines, like the code of conduct, should apply to the whole community, not just github activity).

[vsoch]

Yes! I just updated the text above to reflect that.