Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 4.77 KB

contributing.md

File metadata and controls

100 lines (62 loc) · 4.77 KB
Raw

Contribution

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

Create A New Branch

To create a new branch against develop for your contribution please do the following:

git clone https://github.com/kamranahmedse/developer-roadmap.git # Clone Repo
cd developer-roadmap                                             # Change Directory
git switch develop && git pull                                   # Switch and pull
git checkout -b "a-sensible-branch-name"                         # Create your branch

New Roadmaps

For new roadmaps, you can either:

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 and submit a PR.
  • 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.
  • Maximum of 8 links per topic.
  • Follow the below style guide for content.

How To Structure Content

Please adhere to the following style when adding content to a topic:

# Topic Title

(Content)

Visit the following resources to learn more:

- [Description of link](Link)

Guidelines

  • Please open your pull request (PR) against the develop branch.

    To keep caching and deployments under control, please open your PR's against the develop branch, which will then be merged into master at the end of the day.

  • 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

    Meaningful commit messages help speed up the review process as well as help other contributors in gaining a good overview of the repositories commit history without having to dive into every commit.

    (See the following guide on how to write good commit messages).

  • Look at the existing issues/pull requests before opening new ones

Good vs Not So Good Contributions

Good

  • New Roadmaps.
  • Engaging, fresh content links.
  • Typos and grammatical fixes.
  • Content copy in topics that do not have any (or minimal copy exists).

Not So Good

  • Adding whitespace that doesn't add to the readability of the content.
  • Rewriting content in a way that doesn't add any value.
  • None English content.
  • PR's that don't follow our style guide, have no description and a default title.