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

✨ add guide to community health files #1334

Merged
merged 3 commits into from
Jul 24, 2024
Merged

✨ add guide to community health files #1334

merged 3 commits into from
Jul 24, 2024

Conversation

ctcpip
Copy link
Member

@ctcpip ctcpip commented Jul 10, 2024

resolves #1263

@ctcpip ctcpip requested a review from a team as a code owner July 10, 2024 03:28
@tobie
Copy link
Contributor

tobie commented Jul 10, 2024

We need to move the IP guidance file in this repo too, not sure what it's doing in /governance

@ctcpip
Copy link
Member Author

ctcpip commented Jul 10, 2024

@tobie, my brother you approved the PR that moved it from root 😄 -- #841

@tobie
Copy link
Contributor

tobie commented Jul 10, 2024

@tobie, my brother you approved the PR that moved it from root 😄 -- #841

Lol. @joesepi and I had the same thirst for cleaning things up around the same time but we sync'ed poorly. The organization of content in the repo and in the readme are all off as a result. :D

@ctcpip ctcpip requested a review from a team July 10, 2024 16:40
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@tobie tobie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for getting this started, @ctcpip, this is great!

A few (high-level) comments:

  • Let's avoid setting policy in a guide as much as possible, especially if it conflicts with policy set elsewhere (e.g. the onboarding checklist)
  • I think it's good to be pragmatic about the fact that every project is on GitHub, but we also want to acknowledge when things are github-specific and favor more neutral options whenever possible.
  • Let's also include where the charter goes and so maybe rename the guide accordingly? "Project repository structure"?
  • We use the term project to define a foundation project, so let's avoid mixing GitHub-specific organization/project lingo in here as much as possible.

project-resources/community-health-files-guide.md Outdated Show resolved Hide resolved
project-resources/community-health-files-guide.md Outdated Show resolved Hide resolved
project-resources/community-health-files-guide.md Outdated Show resolved Hide resolved
@ctcpip
Copy link
Member Author

ctcpip commented Jul 12, 2024

@tobie

  • Let's avoid setting policy in a guide as much as possible, especially if it conflicts with policy set elsewhere (e.g. the onboarding checklist)

Is this a general comment on future changes or are there specific instances in the document that are problematic?

  • I think it's good to be pragmatic about the fact that every project is on GitHub, but we also want to acknowledge when things are github-specific and favor more neutral options whenever possible.

#1334 (comment)

  • Let's also include where the charter goes and so maybe rename the guide accordingly? "Project repository structure"?

We're not prescribing how their repository should be structured -- only guidance on community health files.

  • We use the term project to define a foundation project, so let's avoid mixing GitHub-specific organization/project lingo in here as much as possible.

Project refers to open source project / foundation project. A GitHub Project is something else entirely.

@ctcpip
Copy link
Member Author

ctcpip commented Jul 19, 2024

The latest changes address all comments -- and in a way that I hope folks will find satisfactory. Thanks for everyone's help and feedback!

@ctcpip ctcpip requested review from tobie, mcollina, timmywil and Trott July 19, 2024 18:37
@ctcpip
Copy link
Member Author

ctcpip commented Jul 24, 2024

per my last comment, I am going to merge this. discussed with Tobie earlier today and concerns are addressed. if not, let's follow up with a new issue and PRs. I already have some new content to add to this, and will follow up. thanks again everyone!

ctcpip and others added 3 commits July 24, 2024 16:26
Co-authored-by: Tobie Langel <tobie@unlockopen.com>
Signed-off-by: Chris de Almeida <ctcpip@users.noreply.github.com>
@ctcpip ctcpip merged commit 8f81de3 into main Jul 24, 2024
1 check passed
@ctcpip ctcpip deleted the chf branch July 24, 2024 21:27
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.

Document best practices for community health files
7 participants