developer-roadmap icon indicating copy to clipboard operation
developer-roadmap copied to clipboard

[Help Wanted] Add Content to Roadmaps

Open kamranahmedse opened this issue 3 years ago β€’ 18 comments

As you might have noticed that starting from frontend and backend roadmaps we have made the roadmaps interactive. Next, we need your help in adding content to the roadmaps.

How to add Content

All you have to do is follow the steps below:

  • Visit any of the interactive roadmaps.
  • Click any of the nodes on the roadmap and a drawer will open showing the content for the roadmap node.
  • Click the button "Edit this Page" and add the content for the roadmap node by following the guidelines listed below and open a Pull Request.

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

Guidelines are clickable

Do not add things you have not evaluated personally!

There must be a lot of content available for the roadmap items. Evaluate the content and only add the high-quality resources.

One item per Pull Request.

There may be a discussion related to an item you want to add. Adding just a single item per pull request makes it much easier for everyone involved.

Do not open issues with resources, create a Pull Request instead!

kamranahmedse avatar Jan 09 '22 07:01 kamranahmedse

Hello @kamranahmedse 🀝. I was long waiting to add a resource in the frontend roadmap section. I watched a number of videos out there and found one that was the most🎯 fitting as well as appropriate and I would like to contribute onto that. Also, a watchable resource sometimes works even better than readable ones("Sometimes")😊. I would like to work on this issue and also want to contribute in future.πŸš€

anshulyadav01 avatar Jan 09 '22 18:01 anshulyadav01

I just checked out the roadmaps, and they look awesome! to start off, I've opened a PR adding some info to the Go roadmap. Please consider taking a look, thank you! https://github.com/kamranahmedse/developer-roadmap/pull/993 .

karanssh avatar Jan 11 '22 21:01 karanssh

Hi. Is there a free tool to edit the roadmaps or we have to edit the jsons files to do it?

Choose-br avatar Jan 17 '22 13:01 Choose-br

@Choose-br you don't need to edit the JSON files, I have listed the steps in the issue description to add the content.

kamranahmedse avatar Jan 18 '22 12:01 kamranahmedse

I will try to help on the Frontend Roadmap :)

NomarGomez avatar Jan 24 '22 01:01 NomarGomez

Hey everyone How the content is selected to put on site ?

ungaratto93 avatar Jan 25 '22 13:01 ungaratto93

Hello @kamranahmedse I have a question for contribute to Add content, you guys have a guideline on the git flow? (Naming branches, commits, commits messages), I ask because I would like to do it the correct way.

NomarGomez avatar Jan 29 '22 00:01 NomarGomez

@ungaratto93 We strive to have a smaller list of more valuable resources, quality over quantity. Use your critical thinking to filter out non-essential stuff and ask yourself if you would personally recommend this resource to your friend, starting on software development career

@NomarGomez there aren't any conventions for that, just open a pull request following the contribution guidelines and we will squash + merge the commit and change the commit title if needed.

kamranahmedse avatar Feb 09 '22 16:02 kamranahmedse

@kamranahmedse Are you planning to list any paid content? Or should only free resources be submitted?

pshushereba avatar Feb 15 '22 02:02 pshushereba

@pshushereba only free resources for now, please.

kamranahmedse avatar Feb 16 '22 06:02 kamranahmedse

I create content from my organisation, and I wonder if it could be useful to you too.

patbi avatar Feb 24 '22 16:02 patbi

Hi everyone, I have added some content for MongoDB for the backend roadmap. This is my first time doing a PR πŸ˜‡ #1162

May I know where is the contribution docs?

Koodies avatar Mar 01 '22 06:03 Koodies

@Koodies I think this is the contribution docs

aroyan avatar Mar 01 '22 07:03 aroyan

Hi @kamranahmedse I wonder if Could I contribute for qa sections, I have been working in an initiative related technical skills to become a Test Automation Engineer and I see the QA engineer Roadmap is not ready yet.

luisaferco avatar Mar 06 '22 18:03 luisaferco

Hi @kamranahmedse - love the roadmaps and great to see them evolve and grow. I'm just starting out so they've been a big help. I'm brushing up on some of the topics/technologies covered so I'll put some content together and contribute if I can!

jack-m-logan avatar Mar 15 '22 20:03 jack-m-logan

Hey @kamranahmedse, I'd like to contribute to the Android roadmap. Do we have any blockers making that roadmap interactive too?

I'm teaching Android for years now and have links to many free resources waiting aside. I'm also creating some non-monetized youtube videos for Kotlin.

Should I come up with a PR converting the roadmap.png to dom elements, or do we have an action item that needs to be done prior to it?

safaorhan avatar Jul 11 '22 05:07 safaorhan

I would like to help with the AWS roadmap

superissy avatar Jul 19 '22 01:07 superissy