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

Document best practices for community health files #1263

Closed
tobie opened this issue Mar 1, 2024 · 8 comments · Fixed by #1334
Closed

Document best practices for community health files #1263

tobie opened this issue Mar 1, 2024 · 8 comments · Fixed by #1334
Assignees

Comments

@tobie
Copy link
Contributor

tobie commented Mar 1, 2024

Some suggestions to start the conversation:

For single-repo projects

For orgs

@ljharb
Copy link
Member

ljharb commented Mar 1, 2024

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

sheplu commented Mar 4, 2024

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

ljharb commented Mar 4, 2024

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
Copy link
Contributor Author

tobie commented Mar 19, 2024

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

ctcpip commented Jun 11, 2024

@tobie tobie changed the title Document best practices for org/project organizations in GitHub Document best practices for community health files Jun 11, 2024
@tobie tobie added the waiting-on-pull-request There's agreement as to what needs to happen, now someone has to do it. label Jun 25, 2024
@tobie
Copy link
Contributor Author

tobie commented Jun 25, 2024

CPC call: Let's go with a simple version based on the GH docs. The idea is to provide info to onboarding project much like the IP guidelines do. Should be linked from the onboarding checklist.

@ctcpip
Copy link
Member

ctcpip commented Jul 9, 2024

I'll take the first stab at this

@ctcpip
Copy link
Member

ctcpip commented Jul 9, 2024

requesting the creation of a .github repo (and write permission thereof) for the openjs-foundation organization

@ctcpip ctcpip removed the waiting-on-pull-request There's agreement as to what needs to happen, now someone has to do it. label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants