Add readme and contribution docs
This commit is contained in:
14
contributing/guide.md
Normal file
14
contributing/guide.md
Normal file
@ -0,0 +1,14 @@
|
||||
## Submitting a Guide
|
||||
|
||||
First thank you for considering contributing to this project. It wouldn't have been possible for us to keep it live without your contributions 🙏
|
||||
|
||||
> Follow the steps listed below in order to add a new guide
|
||||
|
||||
* 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 markdown file in the [guides directory](../content/guides).
|
||||
* Add the metadata for this guide in [guides.json](../content/guides.json). Please note that `fileName` and `slug` must match.
|
||||
* Open a pull request
|
24
contributing/readme.md
Normal file
24
contributing/readme.md
Normal file
@ -0,0 +1,24 @@
|
||||
## The Goal
|
||||
|
||||
* 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
|
||||
|
||||
* [Submitting roadmaps](./roadmap.md)
|
||||
* [Writing a Guide](./guide.md)
|
||||
* [Submitting resources](./resources.md)
|
||||
|
||||
**No PR will be discarded without explanations!**
|
||||
|
||||
## Guidelines
|
||||
|
||||
- <p><strong>Adding everything available out there is not the goal!</strong><br />
|
||||
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.</p>
|
||||
- <p><strong>Do not add things you have not evaluated personally!</strong><br />
|
||||
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?</p>
|
||||
- <p><strong>One item per Pull Request</strong><br />
|
||||
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.</p>
|
||||
- Write meaningful commit messages
|
||||
- Look at the existing issues/pull requests before opening new ones
|
34
contributing/roadmap.md
Normal file
34
contributing/roadmap.md
Normal file
@ -0,0 +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-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": "Roadmap Name",
|
||||
"description": "Step by step guide to becoming a modern ***",
|
||||
"featuredDescription": "Step by step guide to becoming a modern ** in 2021",
|
||||
"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
|
Reference in New Issue
Block a user