update contribution doc with develop rules

pull/5737/head
Dan Holdsworth 6 months ago committed by Kamran Ahmed
parent bbe66a646f
commit 04f39d4e91
  1. 16
      contributing.md

@ -2,11 +2,23 @@
First of all thank you for considering to contribute. Please look at the details below: First of all thank you for considering to contribute. Please look at the details below:
- [Create a New Branch](#create-a-new-branch)
- [New Roadmaps](#new-roadmaps) - [New Roadmaps](#new-roadmaps)
- [Existing Roadmaps](#existing-roadmaps) - [Existing Roadmaps](#existing-roadmaps)
- [Adding Content](#adding-content) - [Adding Content](#adding-content)
- [Guidelines](#guidelines) - [Guidelines](#guidelines)
## Create A New Branch
To create a new branch against `develop` for your contribution please do the following:
```bash
git clone https://github.com/kamranahmedse/developer-roadmap.git # Clone Repo
cd developer-roadmap # Change Directory
git switch develop && git pull # Switch and pull
git checkout -b "a-sensible-branch-name" # Create your branch
```
## New Roadmaps ## New Roadmaps
For new roadmaps, you can either: For new roadmaps, you can either:
@ -46,6 +58,10 @@ Visit the following resources to learn more:
## Guidelines ## Guidelines
- <p><strong>Please open your pull request (PR) against the develop branch.</strong><br />
To keep caching and deployments under control, please open your PR's against the `develop` branch, which will then be merged into `master` at the end of the day.
- <p><strong>Adding everything available out there is not the goal!</strong><br /> - <p><strong>Adding everything available out there is not the goal!</strong><br />
The roadmaps represent 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.</p> The roadmaps represent 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.</p>

Loading…
Cancel
Save