gaspersic/developer-roadmap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Kamran Ahmed
2021-12-02 17:24:31 +01:00
parent d177a13aa6
commit 17e2ffd110
3 changed files with 4 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
contributing/guide.md
View File

@ -1,14 +0,0 @@
## 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

5
contributing/readme.md
View File

@ -1,14 +1,11 @@
## 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.
* For the resources, please note that they 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!**