From 63c8a9b7afa1df41ce8f976d678692551e848d3b Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Mon, 27 Jan 2020 12:41:02 +0500 Subject: [PATCH] Add contribution guide for writing roadmap --- contributing/roadmap.md | 33 +++++++++++++++++++++++++++++++++ pages/roadmaps.js | 4 ++-- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/contributing/roadmap.md b/contributing/roadmap.md index 412c71373..3f4628902 100644 --- a/contributing/roadmap.md +++ b/contributing/roadmap.md @@ -1 +1,34 @@ # Submitting a new roadmap + +First of all thank you for considering to contribute to this project. It wouldn't have been possible for us to keep it live without your contributions 🙏 + +> This process will be automated soon. Follow the steps listed below in order to add a new roadmap for now + +* Fork this repository +* If you haven't contributed to this project before then create your author profile + * Open the file [authors.json](../content/authors.json) + * Put your preferred `username` + * Put a profile picture in [authors directory](../public/authors) with the username +* Create a new directory for the roadmap inside the [roadmaps directory](../content/roadmaps) by following the below steps: + * Directory name must be `kebab-cased` and prefixed with the incremental number e.g. `6-java-developer` + * Create a markdown file `6-java-developer/0-About/0-Summary.md` inside this directory and write the article detailing the steps required for this path. It doesn't have to be graphic like the other roadmaps; just focus on writing a detailed but approachable textual guide. + * Create a file `meta.json` inside the roadmap directory with the content below: + ```json + { + "title": "Java Developer", + "description": "Step by step guide to becoming a modern Java Developer", + "featuredDescription": "Step by step guide to becoming a modern Java Developer in 2020", + "author": { + "name": "Your Name", + "url": "https://twitter.com/twitter" + }, + "featured": false, + "detailed": false, + "versions": [] + } + ``` +* Once done, run the below command: + ```shell + yarn meta:roadmaps + ``` +* Commit, push and open a pull request diff --git a/pages/roadmaps.js b/pages/roadmaps.js index 814c4a9e1..94bee2902 100644 --- a/pages/roadmaps.js +++ b/pages/roadmaps.js @@ -24,10 +24,10 @@ const RoadmapsList = () => ( title={PageTitle} subtitle={PageDescription}> - + - Request a Roadmap + Write a Roadmap