From 888800d2a0ede8f58d5c4d56eaac8a1adbebd62a Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Wed, 13 Nov 2019 23:07:29 +0400 Subject: [PATCH] Update contribution docs --- contributing/readme.md | 33 ++++++++++++++++++++++++++++++++- contributing/roadmap.md | 33 +-------------------------------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/contributing/readme.md b/contributing/readme.md index 430fd5592..9448727b2 100644 --- a/contributing/readme.md +++ b/contributing/readme.md @@ -1 +1,32 @@ -## Contribute +## 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. + +## 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. + +**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.

+-

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 +- Look at the existing issues/pull requests before opening new ones diff --git a/contributing/roadmap.md b/contributing/roadmap.md index 9448727b2..412c71373 100644 --- a/contributing/roadmap.md +++ b/contributing/roadmap.md @@ -1,32 +1 @@ -## 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. - -## 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. - -**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.

--

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 -- Look at the existing issues/pull requests before opening new ones +# Submitting a new roadmap