Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.6 KB

contributing.md

File metadata and controls

41 lines (27 loc) · 2.6 KB

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 keep the following guidelines in mind when submitting content:

  • Content must be in English.
  • Put a brief description about the topic on top of the file and the a list of links below with each link having title of the URL.

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 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