nodejs.org icon indicating copy to clipboard operation
nodejs.org copied to clipboard

fix: update Project governance page to match reality

Open joyeecheung opened this issue 1 year ago • 6 comments

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.

joyeecheung avatar Mar 20 '24 06:03 joyeecheung

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

vercel[bot] avatar Mar 20 '24 06:03 vercel[bot]

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 🔗

github-actions[bot] avatar Mar 20 '24 06:03 github-actions[bot]

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 :zzz: 0 :x: 0 :fire: 4.774s :stopwatch:

github-actions[bot] avatar Mar 20 '24 06:03 github-actions[bot]

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.

ovflowd avatar Mar 20 '24 10:03 ovflowd

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.

GeoffreyBooth avatar Mar 20 '24 15:03 GeoffreyBooth

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

joyeecheung avatar Mar 20 '24 15:03 joyeecheung