Document best practices for community health files

[tobie]

Some suggestions to start the conversation:

For single-repo projects

• CODE_OF_CONDUCT.md pointing to https://code-of-conduct.openjsf.org
• CHARTER.md
• SECURITY.md
• GOVERNANCE.md ?

For orgs

• .github
  • CODE_OF_CONDUCT.md pointing to https://code-of-conduct.openjsf.org
• governance / tsc repo with:
  • CHARTER.md
  • SECURITY.md
  • GOVERNANCE.md

[ljharb]

Most of the health files can be tucked away inside the .github folder, whether in a single repo or a .github org - i usually prefer to keep them in the root of a .github repo but tucked away in a single repo.

"admin" is also a nice possible name for the governance/etc repo. GOVERNANCE.md and PROJECT_CHARTER.md are what nvm uses for filenames.

[sheplu]

in an org, the .github repository seems to be a good idea for all files that would be shared like the CoC and Security.
Other files like CHARTER or GOVERNANCE are not "shared" in the same way.

What would also be the recommendation for other documents, like the Contributing? Or Triager? Especially for large organization?

[ljharb]

I'd assume any conventionally named repo - "admin", "tsc", something like that? nvm only has one repo of consequence, so i just stuck those files in the nvm repo.

[tobie]

CPC meeting update: Express is offering to be a guinea pig for this. Seems it would be useful to have a joint CPC / Express working session to iron issues out and write down recommendations in the CPC repo / onboarding checklist. /cc @UlisesGascon @wesleytodd

[ctcpip]

GH Docs: default community health files