Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 3.53 KB

contributing.md

File metadata and controls

63 lines (42 loc) · 3.53 KB
Raw

Contribution

First of all thank you for considering to contribute. Please look at the details below:

New Roadmaps

For new roadmaps, submit a roadmap by providing a textual roadmap similar to this roadmap in an issue.

Existing Roadmaps

For the existing roadmaps, please follow the details listed for the nature of contribution:

  • Fixing Typos — Make your changes in the roadmap JSON file
  • Adding or Removing Nodes — Please open an issue with your suggestion.

Note: Please note that our goal is not to have the biggest list of items. Our goal is to list items or skills most relevant today.

Adding Content

Find the content directory inside the relevant roadmap.

Please note that the markdown has a specific format. Please follow the sample format for markdown as given here.

  • Title of the file to represent the node item.

  • Add a brief summary describing the roadmap node (preferably less than 200 characters)

  • Use ResourceGroupTitle tag for the resources heading

    <ResourceGroupTitle>Free Content</ResourceGroupTitle>

  • Use BadgeLink tag for the resource links with below guidelines

    <!-- blue color scheme for the official websites and documentation -->
<BadgeLink colorScheme='blue' badgeText='Official Website' href='https://reactjs.org/'>React Website</BadgeLink>

<!-- green color scheme for the courses -->
<BadgeLink badgeText='Course' colorScheme='green' href='https://example.com'>The Beginner's Guide to React</BadgeLink>

<!-- no color scheme for the video links -->
<BadgeLink badgeText='Watch' href='https://www.youtube.com/watch?v=i793Qm6kv3U'>Understanding React's UI Rendering Process</BadgeLink>

<!-- yellow color scheme for the blog posts and readable text -->
<BadgeLink colorScheme='yellow' badgeText='Read' href='https://www.cloudflare.com/en-gb/learning/dns/what-is-dns/'>What is DNS?</BadgeLink>

Guidelines

  • Adding everything available out there is not the goal!
    The roadmaps represent the skillset most valuable today, i.e., if you were to enter any of the listed fields today, what would you learn?! There might be things that are of-course being used today but prioritize the things that are most in demand today, e.g., agreed that lots of people are using angular.js today but you wouldn't want to learn that instead of React, Angular, or Vue. Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included.

  • Do not add things you have not evaluated personally!
    Use your critical thinking to filter out non-essential stuff. Give honest arguments for why the resource should be included. Have you read this book? Can you give a short article?

  • Create a Single PR for Content Additions

    If you are planning to contribute by adding content to the roadmaps, I recommend you to clone the repository, add content to the [content directory of the roadmap](./content/roadmaps/) and create a single PR to make it easier for me to review and merge the PR.
  • Write meaningful commit messages
  • Look at the existing issues/pull requests before opening new ones