chore: updated contributing guidelines, eslint rules and storybook templates by ovflowd · Pull Request #5294 · nodejs/nodejs.org

ovflowd · 2023-04-18T22:11:31Z

This PR updates the ESLint rules and enforces common consistencies that are easily missed.

This PR also updates the CONTRIBUTING guidelines by adding and enforcing a few new sections across the codebase.

New ESLint rules

Enforce import type
Ban import React default import
Ban import * as React namespace import
Enforce ordering of imports
Enforce destructuring of Component props
Enforce usage of type over interface on React Components

Updated Contributing Guidelines

Added a new section for Unit Tests and Storybooks
Added a new section on how React Components should be coded
This PR also updates all Storybooks to follow the template

IMPORTANT NOTE: Most of the file changes of this PR are ESLint applying these new rules. No actual code change was done here.

ovflowd · 2023-04-18T22:12:46Z

Hey, @nodejs/website, this PR changes our CONTRIBUTING guidelines; hence fast-tracking cannot be applied here.

I request all of you to give a nice review of these changes. Thank you!

…move-old-stories

vercel · 2023-04-19T17:49:03Z

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

Name	Status	Preview	Comments	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 20, 2023 9:07am
nodejs-org-stories	✅ Ready (Inspect)	Visit Preview		Apr 20, 2023 9:07am

Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Signed-off-by: Claudio Wunder <cwunder@gnome.org>

Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> Signed-off-by: Claudio Wunder <cwunder@gnome.org>

…move-old-stories

ovflowd · 2023-04-20T09:03:54Z

@nodejs/website can we get reviews? I wanted to merge this asap as tomorrow I'll be doing a workshop and would like to have these new changes merged by then!

(Pretty much requesting fast-tracking here as I want to have this PR to get merged before we start on other work)

…mplates (#5294) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com>

* feat(unit-test): introduce unit test on website redesign branch (#5178 feat(unit-test): introduce unit test * chore(minor): just a tiny design nitpick * chore: set up storybook (#5191) (#5214) * chore: set up testing-library jest extend (#5231) Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> * chore(dependencies): updated dependencies * feat: create section title component (#5237) Co-authored-by: Wai.Tung <maledong_public@foxmail.com> * 📎 chore(migration): migrate banner component (#5233) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Michael Esteban <mickel13@gmail.com> Co-authored-by: Claudio Wunder <cwunder@gnome.org> * feat: migrate AnimatedPlaceholder component (#5238 Migrate AnimatedPlaceholder component from nodejs.dev and create a new Story. * feat: create article alert component (#5243) * feat: migrate blockquote component (#5259) * feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281) * feat: create article data tag component (#5280) * feat: migrate AuthorList component and add story 🎉 (#5277) Co-authored-by: Michael Esteban <mickel13@gmail.com> * chore(migration): migrate language selector component (#5266) Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Teja Sai Sandeep Reddy Konala <sandeep.konala@knacksystems.com> Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Michael Esteban <mickel13@gmail.com> * feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236) Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Claudio Wunder <cwunder@hubspot.com> * chore: updated contributing guidelines, eslint rules and storybook templates (#5294) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> * chore: contributing quick fix of example Signed-off-by: Claudio Wunder <cwunder@gnome.org> * chore: story guide and react spreading Signed-off-by: Claudio Wunder <cwunder@gnome.org> * chore: remove base styles from old styling * chore: fix storybook styles, imports, typescript config and dependencies (#5319 * chore: optimises tsconfig * chiore: add missing dependencies * chore: type storybook constants * chore: styles moved styles to somewhere else * chore: add global json type definition * chore: i18n aria-label instead of sr-only * chore: added open sans font family and space between imports * chore: moved styles and fixed styles and updated banner stories * fix: stylelint rules * chore: updated tsconfig * chore: fix tests * fix: darkmodetoggle test * chore: stories use index.stories.tsx * chore: adopt turborepo (#5316 * chore: revert pnpm use plain npm * fix: package.json * chore: remove warnings and add node_env * chore: cross-env * fix: fix turbo pipelines * chore: only cache certain files * chore: turbo shouldn't care about coverage outputs * chore: proper inputs and outputs for pipelines * chore: do not store some outputs and updated inputs for lint * chore: added prettier configs * chore: remove console.info * chore: updated inputs of all other entries * fix(package.json) Lint command is missing slashes (#5321 fix(package.json) lint:fix missing slashes * moved `DataTag` to `components/Api` (#5317) Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com> Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> * hot-fix: dependency updates and fix dev runtime * chore: updated start command * migration(Layout): newFooter (#5320) Co-authored-by: Claudio Wunder <cwunder@gnome.org> * feat: migrate EditLink component (#5271) Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Wai.Tung <maledong_public@foxmail.com> * feat(blog) Migrate BlogCard component (#5323) Co-authored-by: Michael Esteban <mickel13@gmail.com> * Issue#5307 - Add framer-motion to the dependency list (#5318) * chore: add remote turbo cache and simplified gh actions cache (#5326)Co-authored-by: Aymen Naghmouchi <aymenadvance@gmail.com> * chore: add remote turbo cache and simplified gh actions cache * chore: updated cache rules * chore: more cache rules --------- Co-authored-by: Aymen Naghmouchi <aymenadvance@gmail.com> * chore: fix storybook local development mode (#5335) * chore: migrate pagination component (#5331) Co-authored-by: Teja Sai Sandeep Reddy Konala <tejasaisandeepreddykonala@MacBook-Pro.local> Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Wai.Tung <maledong_public@foxmail.com> * Chore(node feat) (#5338) Co-authored-by: Claudio Wunder <cwunder@gnome.org> * chore: migrate releases types (#5324) * hotfix: first element no margin-top * (website redesign) Feat(shellbox): migration (#5234) Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Michael Esteban <mickel13@gmail.com> Co-authored-by: Wai.Tung <maledong_public@foxmail.com> * fix(i18n): translation key (#5347) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Claudio Wunder <cwunder@gnome.org> * chore: updated dependencies * chore: vercel enable middleware and i18n redirection (#5300) * feat(unit-test): introduce unit test on website redesign branch (#5178 feat(unit-test): introduce unit test * chore: set up storybook (#5191) (#5214) * feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281) * feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236) Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Claudio Wunder <cwunder@hubspot.com> * chore: updated contributing guidelines, eslint rules and storybook templates (#5294) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> * chore: fix storybook styles, imports, typescript config and dependencies (#5319 * chore: optimises tsconfig * chiore: add missing dependencies * chore: type storybook constants * chore: styles moved styles to somewhere else * chore: add global json type definition * chore: i18n aria-label instead of sr-only * chore: added open sans font family and space between imports * chore: moved styles and fixed styles and updated banner stories * fix: stylelint rules * chore: updated tsconfig * chore: fix tests * fix: darkmodetoggle test * chore: stories use index.stories.tsx * chore: adopt turborepo (#5316 * chore: revert pnpm use plain npm * fix: package.json * chore: remove warnings and add node_env * chore: cross-env * fix: fix turbo pipelines * chore: only cache certain files * chore: turbo shouldn't care about coverage outputs * chore: proper inputs and outputs for pipelines * chore: do not store some outputs and updated inputs for lint * chore: added prettier configs * chore: remove console.info * chore: updated inputs of all other entries * feat(stability): migrate component * chore(snapshot): update * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <cwunder@gnome.org> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <cwunder@gnome.org> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <cwunder@gnome.org> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> * fea(stability): update stories + fix * Update components/Api/Stability/index.stories.tsx Co-authored-by: Claudio Wunder <cwunder@gnome.org> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> * fix(i18n): update turkish language direction (#5182) * chore: rollback CODEOWNER changes (#5183) * Sync: merge `major/website-redesign` into `main` (#5356) Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> Co-authored-by: Wai.Tung <maledong_public@foxmail.com> Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Michael Esteban <mickel13@gmail.com> Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Teja Sai Sandeep Reddy Konala <sandeep.konala@knacksystems.com> Co-authored-by: Claudio Wunder <cwunder@hubspot.com> Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com> Co-authored-by: Aymen Naghmouchi <aymenadvance@gmail.com> Co-authored-by: Teja Sai Sandeep Reddy Konala <tejasaisandeepreddykonala@MacBook-Pro.local> Co-authored-by: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Co-authored-by: Guilherme Araújo <guilherme.araujo@maxxidata.com> Co-authored-by: Augustin Mauroy <augustin.mauroy@outlook.fr> Co-authored-by: HinataKah0 <128208841+HinataKah0@users.noreply.github.com> Co-authored-by: Olaleye Blessing <Olayinkablexxy@gmail.com> Co-authored-by: ktssr <31731919+ktssr@users.noreply.github.com> Co-authored-by: Harkunwar Kochar <10580591+Harkunwar@users.noreply.github.com> Co-authored-by: vasanthkumar <42891954+vasanth9@users.noreply.github.com> Co-authored-by: Floran Hachez <floran.hachez@gmail.com> Co-authored-by: Jatin <96469998+JatinSharma32@users.noreply.github.com> * feat(stability): update snapshot * Update components/Api/Stability/index.tsx Co-authored-by: Jithil P Ponnan <MrJithil@users.noreply.github.com> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> * code format * Update components/Api/Stability/index.tsx Co-authored-by: Jithil P Ponnan <MrJithil@users.noreply.github.com> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> --------- Signed-off-by: Claudio Wunder <cwunder@gnome.org> Signed-off-by: Augustin Mauroy <augustin.mauroy@outlook.fr> Co-authored-by: Claudio Wunder <cwunder@hubspot.com> Co-authored-by: Guilherme Araújo <guilherme.araujo@maxxidata.com> Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> Co-authored-by: Claudio Wunder <cwunder@gnome.org> Co-authored-by: Wai.Tung <maledong_public@foxmail.com> Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Michael Esteban <mickel13@gmail.com> Co-authored-by: HinataKah0 <128208841+HinataKah0@users.noreply.github.com> Co-authored-by: Olaleye Blessing <Olayinkablexxy@gmail.com> Co-authored-by: ktssr <31731919+ktssr@users.noreply.github.com> Co-authored-by: Teja Sai Sandeep Reddy Konala <sandeep.konala@knacksystems.com> Co-authored-by: Harkunwar Kochar <10580591+Harkunwar@users.noreply.github.com> Co-authored-by: vasanthkumar <42891954+vasanth9@users.noreply.github.com> Co-authored-by: Jatin <96469998+JatinSharma32@users.noreply.github.com> Co-authored-by: Aymen Naghmouchi <aymenadvance@gmail.com> Co-authored-by: Teja Sai Sandeep Reddy Konala <tejasaisandeepreddykonala@MacBook-Pro.local> Co-authored-by: Yagiz Nizipli <yagiz@nizipli.com> Co-authored-by: Nick Schonning <nschonni@gmail.com> Co-authored-by: Floran Hachez <floran.hachez@gmail.com> Co-authored-by: Jithil P Ponnan <MrJithil@users.noreply.github.com>

Claudio Wunder added 7 commits April 19, 2023 00:07

chore(stories): made stories consistent
7915ad7

chore(stories): removed old stories
eb64749

chore: added new eslint rules to enforce consistency
1c7ec68

chore: added eslint dependencies
569ff03

chore: linted codeowners
91e3095

feat: updated contributing guidelines
719f31b

chore: applied eslint on the branch
6de80bb

ovflowd requested a review from a team as a code owner April 18, 2023 22:11

chore: updated affected snapshot
ad984e3

ovflowd added the website redesign Issue/PR part of the Node.js Website Redesign label Apr 18, 2023

ovflowd changed the title ~~chore(stories): made stories consistent~~chore: updated contributing guidelines, eslint rules and storybook templatesApr 18, 2023

shanpriyan reviewed Apr 19, 2023
View reviewed changes

Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
Comment thread.eslintrc Outdated

shanpriyanand others added 2 commits April 19, 2023 19:57

Merge branch 'major/website-redesign' into chore/normalise-stories-re…
b87ed26
…move-old-stories

chore: relinted latest changes
ea83424

Claudio Wunderand others added 2 commits April 19, 2023 19:50

chore: update docs
328b763

Apply suggestions from code review
af3924f
Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Signed-off-by: Claudio Wunder <cwunder@gnome.org>

ovflowd requested a review from shanpriyan April 19, 2023 17:51

vercelBot temporarily deployed to Preview April 19, 2023 17:58 Inactive

manishprivet reviewed Apr 20, 2023
View reviewed changes

Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated

Apply suggestions from code review
92a2900
Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com> Signed-off-by: Claudio Wunder <cwunder@gnome.org>

vercelBot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 07:30 Inactive

vercelBot temporarily deployed to Preview – nodejs-org April 20, 2023 07:36 Inactive

Merge branch 'major/website-redesign' into chore/normalise-stories-re…
412a7fb
…move-old-stories

vercelBot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 07:46 Inactive

vercelBot temporarily deployed to Preview – nodejs-org April 20, 2023 07:46 Inactive

Merge branch 'major/website-redesign' into chore/normalise-stories-re…
5fa8599
…move-old-stories

vercelBot temporarily deployed to Preview – nodejs-org April 20, 2023 08:00 Inactive

vercelBot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 08:01 Inactive

chore: updated content from rebase (and fixed some styles)
88f12fb

vercelBot temporarily deployed to Preview – nodejs-org April 20, 2023 08:29 Inactive

vercelBot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 08:34 Inactive

chore: updated eslint rules and enforced them
8b1ad5d

vercelBot temporarily deployed to Preview – nodejs-org April 20, 2023 09:06 Inactive

vercelBot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 09:07 Inactive

ovflowd requested review from benhalverson and manishprivet April 20, 2023 09:31

ovflowd added the fast-track Fast Tracking PRs label Apr 20, 2023

rodion-arr approved these changes Apr 20, 2023
View reviewed changes

manishprivet approved these changes Apr 20, 2023
View reviewed changes

ovflowd merged commit bfcabb9 into nodejs:major/website-redesignApr 20, 2023

ovflowd deleted the chore/normalise-stories-remove-old-stories branch April 20, 2023 12:01

ovflowd added a commit that referenced this pull request May 3, 2023
chore: updated contributing guidelines, eslint rules and storybook te…
6407340
…mplates (#5294) Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com> Co-authored-by: Manish Kumar ⛄ <manishprivet@protonmail.com>

Navigation Menu

Uh oh!

chore: updated contributing guidelines, eslint rules and storybook templates - #5294

chore: updated contributing guidelines, eslint rules and storybook templates#5294
ovflowd merged 17 commits into
nodejs:major/website-redesignfrom
ovflowd:chore/normalise-stories-remove-old-stories

ovflowd commented Apr 18, 2023•
edited
Loading

Uh oh!

ovflowd commented Apr 18, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vercelBot commented Apr 19, 2023•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

ovflowd commented Apr 20, 2023•
edited
Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

ovflowd commented Apr 18, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New ESLint rules

Updated Contributing Guidelines

Uh oh!

ovflowd commented Apr 18, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vercelBot commented Apr 19, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ovflowd commented Apr 20, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ovflowd commented Apr 18, 2023•
edited
Loading

vercelBot commented Apr 19, 2023•
edited
Loading

ovflowd commented Apr 20, 2023•
edited
Loading