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

Refactor team profile components for enhanced readability and added t… #10575

Closed
wants to merge 1 commit into from

Conversation

artshllk
Copy link

…ype safety to the playground file

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

The primary motivation behind these changes was to improve the clarity and efficiency of the codebase while leveraging TypeScript's type safety features. This will help prevent potential bugs and facilitate easier collaboration among developers.

Test Plan

Verified that all components render correctly with the updated structure.
Ensured that TypeScript checks pass without any errors or warnings.
Conducted manual testing to confirm that all links and translations function as expected.

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@facebook-github-bot
Copy link
Contributor

Hi @artshllk!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Copy link

netlify bot commented Oct 10, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit c85dbfb
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/67080de99fdf0c000854e5dc
😎 Deploy Preview https://deploy-preview-10575--docusaurus-2.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

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 72 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 51 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 59 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 48 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 63 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟠 86 Report

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Thanks, but these components are already well-typed and I fail to see how this PR improves any safety.

@Josh-Cena Josh-Cena closed this Oct 10, 2024
@artshllk
Copy link
Author

Thanks, but these components are already well-typed and I fail to see how this PR improves any safety.

Nothing, don't mind. I saw some redundant code and created TeamRow component that takes a list of profiles and renders them, reducing redundancy in the individual team row components. Anyway I agree these components are well-typed.

I saw these components don't have tests. Can I make a pull request to test them individually or you think it's not needed?

Cheers!

@Josh-Cena
Copy link
Collaborator

I don't think that's needed. They are changed less than once a year and we can just visually test them.

@Josh-Cena Josh-Cena added the closed: invalid This issue / PR is low quality, unwanted or spam and doesn't qualify as a contribution in any way. label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: invalid This issue / PR is low quality, unwanted or spam and doesn't qualify as a contribution in any way.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants