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

Added JS Roadmap #2933

Closed
wants to merge 3 commits into from
Closed

Added JS Roadmap #2933

wants to merge 3 commits into from

Conversation

dhairyagothi
Copy link
Contributor

@dhairyagothi dhairyagothi commented Jul 11, 2024

Related Issue

Description

Added Javascript roadmap
[Please include a brief description of the changes or features added]

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Security enhancement
  • Other (specify): _______________

Screenshots / Videos (if applicable)

[Attach any relevant screenshots or videos demonstrating the changes]

Checklist

  • I have performed a self-review of my code.
  • I have read and followed the Contribution Guidelines.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have followed the code style guidelines of this project.
  • I have checked for any existing open issues that my pull request may address.
  • I have ensured that my changes do not break any existing functionality.
  • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.
  • I have read the resources for guidance listed below.
  • I have followed security best practices in my code changes.

Additional Context

[Include any additional information or context that might be helpful for reviewers.]

Resources for Guidance

Please read the following resources before submitting your contribution:

Resources for DSA Features on Our Site:

Contribution Guidelines

Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines:

Issue Creation

  1. Limit on Issues:
    • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.

Contribution Levels

  1. Basic Contributions:

    • This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests.
    • For these tasks, issues will be assigned the level1 label.
  2. Acknowledging Hard Work:

    • If a contributor puts in significant effort on a task, the issue will be upgraded to level2. This is our way of recognizing and appreciating extra effort.
  3. Feature Additions and Component Work:

    • Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work.
    • The more complex and valuable the contribution, the higher the level assigned.

Level Definitions

  • Level1:
    • Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates.
  • Level2:
    • Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements.
  • Level3:
    • Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components.

We look forward to your contributions and appreciate your effort in helping us improve the project!

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Great job, @dhairyagothi! 🎉 Thank you for submitting your pull request to CodeHarborHub. We appreciate your contribution and enthusiasm! Our team will review it soon. If you have any questions or need further assistance, feel free to reach out. Thanks for contributing!

Copy link
Contributor

deepsource-io bot commented Jul 11, 2024

Here's the code health analysis summary for commits 424b4d3..44b24c9. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource JavaScript LogoJavaScript❌ Failure
❗ 16 occurences introduced
View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

{ id: 2, name: "CSS", link: "#" },
{ id: 3, name: "JavaScript", link: "#" },
{ id: 2, name: "CSS", link: "" },
{ id: 3, name: "JavaScript", link: "../database/Roadmap/Js" },
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is not working Please tell changes to do

Copy link
Member

Choose a reason for hiding this comment

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

  1. Navigate to the pages/roadmap directory and create a new file named javascript/index.tsx.
  2. Import the content from database/Roadmap/Js into this new file.
  3. Write the code for the new JavaScript roadmap page in javascript/index.tsx.
  4. Update the import path in src/components/Roadmap/index.tsx by replacing ../database/Roadmap/Js with /roadmap/javascript.

@ajay-dhangar ajay-dhangar added GSSOC'24 GirlScript Summer of Code | Contributor level2 GirlScript Summer of Code | Contributor's Levels gssoc GirlScript Summer of Code | Contributor javascript Pull requests that update Javascript code labels Jul 11, 2024
Copy link
Member

@ajay-dhangar ajay-dhangar left a comment

Choose a reason for hiding this comment

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

@dhairyagothi, change your code based on suggestions

@dhairyagothi
Copy link
Contributor Author

image

added @ajay-dhangar

@ajay-dhangar
Copy link
Member

ajay-dhangar commented Jul 11, 2024

@dhairyagothi, the current roadmap design needs improvement for better clarity and user experience. For inspiration and guidance, please refer to the UI/UX of roadmap.sh/javascript.

Copy link
Member

@ajay-dhangar ajay-dhangar left a comment

Choose a reason for hiding this comment

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

@dhairyagothi, Please focus on best practices when using CSS, especially since we are handling large amounts of content. It's important to use specific components and CSS rules, such as parent-child relationships, to ensure our styles are efficient and maintainable. Additionally, consider using tools like styled-components for better organization and scalability.

@dhairyagothi
Copy link
Contributor Author

sure i am trying to make it as like you said

@dhairyagothi
Copy link
Contributor Author

@ajay-dhangar i want to ask that if i can make a figma design and later convert it into html css and adding it .tsx file then its okay ?

@ajay-dhangar
Copy link
Member

@ajay-dhangar i want to ask that if i can make a figma design and later convert it into html css and adding it .tsx file then its okay ?

Absolutely! Converting a Figma design into HTML/CSS and integrating it into a .tsx file is a great approach for enhancing UI/UX.

@ajay-dhangar
Copy link
Member

@dhairyagothi, I appreciate your willingness to help with my open source projects. However, please keep in mind that I want to respect your time, knowing you're actively contributing to multiple projects. Longer discussions might complicate things or create issues based on your PRs or contributions.

@dhairyagothi
Copy link
Contributor Author

Sure @ajay-dhangar i will make pr ASAP

@dhairyagothi
Copy link
Contributor Author

image

@ajay-dhangar please consider this for now

Copy link
Member

@ajay-dhangar ajay-dhangar left a comment

Choose a reason for hiding this comment

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

Please update the code based on the suggestions. Focus on enhancing the design and making data handling with props and mapping more efficient. For reference, you can visit https://github.com/CodeHarborHub/codeharborhub.github.io/tree/main/src/data/roadmaps. Create a JavaScript file there and add the relevant topics.

NOTE: you can write code only one file like javascript/index.tsx

For Example

src/database/roadmap/css/index.tsx

type ResourceLink = {
  url: string;
  text: string;
};

type SubTopic = {
  id: string;
  title: string;
  description: string;
  links: ResourceLink[];
};

type Topic = {
  id: number;
  title: string;
  content: SubTopic[];
};

const cssRoadmap: Topic[] = [
  {
    id: 1,
    title: "Introduction to CSS",
    content: [
      {
        id: "1.1",
        title: "What is CSS?",
        description: "Learn about the basics of CSS and its importance in web development.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Learn/CSS/First_steps/What_is_CSS", text: "MDN Web Docs" },
          { url: "https://www.w3schools.com/css/css_intro.asp", text: "W3Schools Introduction to CSS" }
        ]
      },
      {
        id: "1.2",
        title: "CSS Syntax and Selectors",
        description: "Understand the syntax of CSS and how to use selectors to style elements.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors", text: "MDN CSS Selectors" },
          { url: "https://www.w3schools.com/css/css_syntax.asp", text: "W3Schools CSS Syntax" }
        ]
      }
    ]
  },
  {
    id: 2,
    title: "CSS Fundamentals",
    content: [
      {
        id: "2.1",
        title: "Colors and Backgrounds",
        description: "Learn how to apply colors and background styles to elements.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Web/CSS/color", text: "MDN Colors" },
          { url: "https://www.w3schools.com/css/css_background.asp", text: "W3Schools Backgrounds" }
        ]
      },
      {
        id: "2.2",
        title: "Box Model",
        description: "Understand the CSS box model and how it affects element layout.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model", text: "MDN Box Model" },
          { url: "https://www.w3schools.com/css/css_boxmodel.asp", text: "W3Schools Box Model" }
        ]
      }
    ]
  },
  {
    id: 3,
    title: "Advanced CSS",
    content: [
      {
        id: "3.1",
        title: "Flexbox",
        description: "Learn about the Flexbox layout model and how to use it for responsive designs.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout", text: "MDN Flexbox" },
          { url: "https://www.w3schools.com/css/css3_flexbox.asp", text: "W3Schools Flexbox" }
        ]
      },
      {
        id: "3.2",
        title: "Grid",
        description: "Understand CSS Grid and how it can be used to create complex layouts.",
        links: [
          { url: "https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout", text: "MDN Grid" },
          { url: "https://www.w3schools.com/css/css_grid.asp", text: "W3Schools Grid" }
        ]
      }
    ]
  }
];

export default cssRoadmap;

@@ -0,0 +1,96 @@
body {
Copy link
Member

Choose a reason for hiding this comment

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

remove

body {
    font-family: sans-serif;
    background-color: #f4f4f4;
  }

Copy link
Member

Choose a reason for hiding this comment

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

you need to read carefully #2933 (review) I shared alreade for css

Copy link
Member

Choose a reason for hiding this comment

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

@ajay-dhangar ajay-dhangar removed the level2 GirlScript Summer of Code | Contributor's Levels label Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc GirlScript Summer of Code | Contributor GSSOC'24 GirlScript Summer of Code | Contributor javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants