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

chore: add charter #14948

Merged
merged 9 commits into from
Apr 23, 2024
Merged

chore: add charter #14948

merged 9 commits into from
Apr 23, 2024

Conversation

SimenB
Copy link
Member

@SimenB SimenB commented Mar 8, 2024

Summary

This text is like 95% pure copy from @ljharb's work in https://github.com/nvm-sh/nvm, so big thanks to him for authoring minimal versions I could base it off of 😀 Hopefully this amount of copying is fine, and I did 't miss anything

My main changes (beyond describing Jest rather than nvm 😅) is to add an addition "layer" of contributors in between external contributors and admins. Hopefully that makes sense?

Closes #14927

Test plan

Review by people who can approve the text within.

@SimenB SimenB requested a review from bensternthal March 8, 2024 11:52
Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for jestjs ready!

Name Link
🔨 Latest commit 24d18c8
🔍 Latest deploy log https://app.netlify.com/sites/jestjs/deploys/6627eeeba91631000810af17
😎 Deploy Preview https://deploy-preview-14948--jestjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

LGTM, fwiw :-)

@bensternthal
Copy link
Contributor

@SimenB I filled the following issue in the CPC repo to track approval of the charter. Let's wait on merging until we get some more approvals/feedback.

Overall this is looking really good!

Copy link

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

LGTM! (Approving as fellow OpenJS CPC member)

Copy link

@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.

A few proposed suggestions. Overall, this looks good!

Comment on lines 44 to 51

- _Outside Contributors_: contribute code or other artifacts, but do not have the right to commit to the codebase. Contributors work with the project’s maintainers to have code committed to the code base. An Outside Contributor may be promoted to a Contributor or Maintainer by the Maintainers. Outside Contributors should rarely be encumbered by the Maintainers and never by the CPC or OpenJS Foundation Board.

- _Contributors_: Contributors have triaging rights and commit access to the repository.

- _Maintainers_: Contributors with any kind of decision-making authority in the project, and access to publishing and CI setup.

[openjs foundation]: https://openjsf.org
Copy link

Choose a reason for hiding this comment

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

I'd lighten this section a bit and avoid anything that feels like an implementation detail of the charter. For example, stating that contributors have commit access to the repository forces you to go through a CPC charter modification process the day you want change that.

Copy link
Member Author

Choose a reason for hiding this comment

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

specifically the commit access, or triaging etc as well? I essentially wanted to capture the different accesses GH provides

image

But with merging "maintainer" and "admin". I guess just having triaging makes sense. And actually what I want in the future, as I wanna set up CI publishing, and that would mean push access is enough to trigger a release.

Copy link

Choose a reason for hiding this comment

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

I'd frame this outside of GH roles and would avoid the internal/external terminology for contributors (which tends to be tied to differentiating employee and non-employee contributors in corporate open source settings). You also don't really need to define non-core contributors. So you could go with something very light-weight, for example:

Maintainers: responsible for the technical direction of the project and for release management.
Core contributors: Maintainers delegate project responsibilities to core contributors, as documented in governance.md.

Copy link
Contributor

Choose a reason for hiding this comment

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

@SimenB does adjusting this section to just be the following make sense?

Maintainers: responsible for the technical direction of the project and for release management.
Core contributors: Maintainers delegate project responsibilities to core contributors, as documented in governance.md.

Copy link
Member Author

Choose a reason for hiding this comment

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


### Section 4.2: Decision-making, Voting, and/or Elections

Section Intentionally Left Blank
Copy link

Choose a reason for hiding this comment

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

It would be nice to state who makes project decisions and how (is it by consensus, voting, etc.)

Copy link
Member Author

Choose a reason for hiding this comment

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

Since I'm the only active maintainer, I don't know what to put here that's. I'd love for there to be more stakeholders/maintainers involved in the process (and in maintaining the project as a whole), but at the moment any voting/consensus would just be myself 😅

Copy link

Choose a reason for hiding this comment

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

I think you being candid about it and being a little aspirational here would make total sense, e.g.

When the project was onboarded, it only had one maintainer. The goal is to grow the pool of maintainers and to collectively define a consensus-driven governance model that will be defined in GOVERNANCE.md.

or:

The project will define a consensus-driven governance model in GOVERNANCE.md as need arises.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think Tobie's second suggestion will work well and provides future flexibility.

Copy link
Member Author

Choose a reason for hiding this comment

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

GOVERNANCE.md Show resolved Hide resolved
PROJECT_CHARTER.md Outdated Show resolved Hide resolved
Co-authored-by: Tobie Langel <[email protected]>
@mcollina
Copy link

mcollina commented Mar 9, 2024

Lgtm

@tobie
Copy link

tobie commented Apr 2, 2024

Hey! The CPC was wondering if the various comments had been addressed and whether we could move forward with the review.

Copy link

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@SimenB
Copy link
Member Author

SimenB commented Apr 22, 2024

@tobie @bensternthal sorry about the delay, I've had a bout of mini burnout in the last couple of months and have focused on other projects besides Jest 😅

Hopefully the tweaks I just pushed allows us to move this forward!

@bensternthal
Copy link
Contributor

@SimenB, nice work; this looks good to me 😸 . @tobie we good to merge?!

PROJECT_CHARTER.md Outdated Show resolved Hide resolved
PROJECT_CHARTER.md Outdated Show resolved Hide resolved
@tobie
Copy link

tobie commented Apr 22, 2024

LGTM!

@bensternthal
Copy link
Contributor

@SimenB feel free to merge \o/

@SimenB SimenB merged commit 69fe211 into jestjs:main Apr 23, 2024
8 of 9 checks passed
@SimenB SimenB deleted the add-charter branch April 23, 2024 17:25
@SimenB
Copy link
Member Author

SimenB commented Apr 23, 2024

Thanks, folks 👍

Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OpenJS Onboarding: Create & Publish Project Charter
6 participants