Add contribution docs

pull/1657/head
Kamran Ahmed 6 years ago
parent 65fbeef271
commit 2c0bc95339
  1. 6
      .vscode/settings.json
  2. 30
      contributing.md
  3. 19
      readme.md

@ -1,6 +0,0 @@
{
"[json]": {
"editor.formatOnSave": false,
"editor.formatOnPaste": false
},
}

@ -0,0 +1,30 @@
## 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 <kbd>Project > Import > Mockup JSON</kbd>,
* Copy and paste the JSON for the roadmap that you want to update
* Add your changes
* Export the JSON file <kbd>Project > Export > Mockup to JSON</kbd> and put it in the <kbd>project</kbd> directory
* Export the image <kbd>Project > Export > Current Mockup to PNG</kbd> and put it in the <kbd>images</kbd> 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

@ -29,24 +29,9 @@ Below you find a set of charts demonstrating the paths that you can take and the
If you think any of the roadmaps can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.
## ☑ TODO
## 🙌 Contribution
- [X] Add Frontend Roadmap
- [X] Add Backend Roadmap
- [X] Add DevOps Roadmap
- [ ] Add relevant resources for each
## 👫 Contribution
> _**PRE-REQUISITE**: The roadmaps are built using [Balsamiq →](https://balsamiq.com/products/mockups/)_
1. 🤔 **WHERE**: Project file can be found at [`/project`](./project) directory
2. ⬇ **IMPORT**: To modify any of the roadmaps, open Balsamiq, click <kbd>Project</kbd><kbd>Import</kbd><kbd>Mockup JSON</kbd>, put the relevant JSON file data from any roadmap in the [`/project`](./project) directory in Balsamiq
3. 😮 **WHAT**: This will open the relevant roadmap for you. Now update it (double-click to edit text) and make all the changes
4. ⬆ **EXPORT**:
1. 🖨 **JSON**: Export Mockup to JSON, click <kbd>Project</kbd><kbd>Export</kbd><kbd>Mockup to JSON</kbd> and update it in the [`/project`](./project) directory
2. 🖼 **IMAGES**: Before exporting images, make the background transparent (click <kbd>Project</kbd><kbd>Export</kbd><kbd>Use Transparent Background</kbd>). Now export the images (click <kbd>Project</kbd><kbd>Export</kbd><kbd>All Mockups to PNG</kbd>). Update the relevant images (keep the same name so you don't have to edit the `README.md` file) in the [`/images`](./images) directory
5. 🚀 **PR**: Create a Pull Request for this repository (make sure to explain what you changed in the description)
> Have a look at [contribution docs](./contributing.md) for how to update any of the roadmaps
- Open pull request with improvements
- Discuss ideas in issues

Loading…
Cancel
Save