From bb3260f4b7a0931cfa51f9c3ce256668f5224c39 Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Mon, 27 Jan 2020 13:09:16 +0500 Subject: [PATCH] Update contribution guidelines --- contributing/readme.md | 26 +++++++++----------------- contributing/resources.md | 6 ++++++ contributing/roadmap.md | 8 ++++---- 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/contributing/readme.md b/contributing/readme.md index c635e926a..7753dd5ef 100644 --- a/contributing/readme.md +++ b/contributing/readme.md @@ -1,31 +1,23 @@ ## The Goal -Our goal is not to have the biggest list of everything available out there. -Our goal is to have a list of things that anybody would have to learn if they were to enter the field today. + +* For the roadmaps, we encourage you to discuss and contribute with new roadmaps. For the existing ones, please note that our goal is to not have the biggest list of items. Our goal is to have a list of items or skills most relevant today. +* For the guides, please pick a topic, open an issue or reach out on twitter [@kamranahmese](https://twitter.com/kamranahmedse) to get the go-ahead and [start writing](./guide.md). +* For the resources, we are still preparing the contribution guidelines but submit them in an issue for now. Just note that the resources are *highly opinionated* and *curated*. Your opinion on value of any resource may not match the opinion of curator. ## Contributing -Your contributions to this repo are always welcome! -Bear in mind, that this repo is *highly opinionated*, *unbiased* and *curated*. -Your opinion on value of any resource may not match the opinion of curator. +* [Submitting roadmaps](./roadmap.md) +* [Writing a Guide](./guide.md) +* [Submitting resources](./resources.md) **No PR will be discarded without explanations!** -## How are these roadmaps made? - -> Roadmaps are made using [Balsamiq](https://balsamiq.com/download/) - -* Clone the repository -* Open Balsamiq, click Project > Import > Mockup JSON, -* Copy and paste the JSON for the roadmap that you want to update -* Add your changes -* Export the JSON file Project > Export > Mockup to JSON and put it in the project directory -* Export the image Project > Export > Current Mockup to PNG and put it in the images directory -* Commits your changes and open a PR - ## Guidelines -

Adding everything available out there is not the goal!
The roadmaps represents 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?

-

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.

- Write meaningful commit messages diff --git a/contributing/resources.md b/contributing/resources.md index e69de29bb..02fde5364 100644 --- a/contributing/resources.md +++ b/contributing/resources.md @@ -0,0 +1,6 @@ +# Suggesting Resources + +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 🙏 + +> Please note that we are + diff --git a/contributing/roadmap.md b/contributing/roadmap.md index 3f4628902..58e2789ee 100644 --- a/contributing/roadmap.md +++ b/contributing/roadmap.md @@ -11,13 +11,13 @@ First of all thank you for considering to contribute to this project. It wouldn' * 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 markdown file `6-roadmap-name/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", + "title": "Roadmap Name", + "description": "Step by step guide to becoming a modern ***", + "featuredDescription": "Step by step guide to becoming a modern ** in 2020", "author": { "name": "Your Name", "url": "https://twitter.com/twitter"