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

fix: update Project governance page to match reality #6493

Merged
merged 3 commits into from Mar 28, 2024
Merged

Conversation

joyeecheung
Copy link
Member

I noticed that the governance page (source is https://github.com/nodejs/nodejs.org/blob/main/pages/en/about/governance.md) appears to be out of sync and probably is copied from an older document that used incorrect descriptions. At least it does not match what we say in https://github.com/nodejs/node/blob/main/GOVERNANCE.md now and I remember we made sure that it was clear it's collaborators who nominate collaborators (which is also what we do in practice).

Here is my attempt at clarifying the text.

cc @nodejs/tsc

Description

Validation

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npx turbo format to ensure the code follows the style guide.
  • I have run npx turbo test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

I noticed that the governance page (source is https://github.com/nodejs/nodejs.org/blob/main/pages/en/about/governance.md) appears to be out of sync and probably is copied from an older document that used incorrect descriptions. At least it does not match what we say in https://github.com/nodejs/node/blob/main/GOVERNANCE.md now and I remember we made sure that it was clear it's collaborators who nominate collaborators (which is also what we do in practice).

Here is my attempt at clarifying the text.

cc @nodejs/tsc



Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com>
@joyeecheung joyeecheung requested a review from a team as a code owner March 20, 2024 06:04
Copy link

vercel bot commented Mar 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Mar 20, 2024 6:08am

Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com>
Copy link
Member

@GeoffreyBooth GeoffreyBooth left a comment

Choose a reason for hiding this comment

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

Should this just be the other governance doc, rather than being a separate file that can get out of sync?

Copy link
Contributor

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

github-actions bot commented Mar 20, 2024

Lighthouse Results

URL Performance Accessibility Best Practices SEO Report
/en 🟢 100 🟢 90 🟢 100 🟢 91 🔗
/en/about 🟢 99 🟢 91 🟢 100 🟢 91 🔗
/en/about/previous-releases 🟢 100 🟢 90 🟢 100 🟢 92 🔗
/en/download 🟢 100 🟠 89 🟢 100 🟢 91 🔗
/en/blog 🟢 100 🟢 90 🟢 100 🟢 92 🔗

Copy link

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 84%
80.07% (450/562) 79.55% (144/181) 71.17% (79/111)

Unit Test Report

Tests Skipped Failures Errors Time
90 0 💤 0 ❌ 0 🔥 4.774s ⏱️

@ovflowd
Copy link
Member

ovflowd commented Mar 20, 2024

Should this just be the other governance doc, rather than being a separate file that can get out of sync?

You mean as a link to the actual Markdown doc? I'm fine with that, also.

@GeoffreyBooth
Copy link
Member

You mean as a link to the actual Markdown doc?

However you want to do it; a link, or pulling that document into the build for the website somehow, whatever. Having two copies of it just means two things that can get out of sync, or worse, two places to haggle over language.

@joyeecheung
Copy link
Member Author

I think it's nice to have a brief summary of the governance model - I doubt how many browsing our websites would be entertained reading the long governance doc. Another solution is to have a TL;DR in the governance doc, and somehow sync that part to the website, or on the website only render the TL;DR

Copy link
Member

@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

@ovflowd ovflowd added this pull request to the merge queue Mar 28, 2024
Merged via the queue into main with commit cb3d05f Mar 28, 2024
15 checks passed
@ovflowd ovflowd deleted the project-governance branch March 28, 2024 23:13
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.

None yet

8 participants