Resources have to be in the form of links. Allowed resources can be videos, articles, tutorials, or anything similar. It has to be helpful, whether as a tool to be used or as a source of information.
Here are some rules to follow when adding a resource:
- single blog posts are not accepted. This is simply because if single blog posts are allowed then this list would be endless. There could be some exceptions, like if the single post is very extensive or includes details that are hard to find elsewhere. If the resource you're adding falls under the exception then please detail that in the PR.
- If you want to add multiple links of the same topic under the same website, just include a general link that might lead to all these links. For example, instead of adding multiple Youtube videos under the same series, add the playlist link.
- Take the time to make sure the resource has not been already added as it saves the maintainers time when reviewing your pull request.
- Fork the repository
- Edit the README.md file
-
Find the correct category for your resource. For example: If it's a JavaScript tutorial, you need to add it under Javascript. If the category does not exist, you can add it under Index. Resources are added in alphabetical order, except for other which should stay at last.
-
To add a new category, add a list item with the name of the category and the URL to it (hash of the slug of the name). For example:
- [New Category](#new-category)- Once you find or add the correct category, add the new resource at the end of the list. It should have the title and the link to the resource. For example:
- [Web-3](https://learnweb3.io/)You also have to add an emoji before the file name that represents what the resource is. Here are the list of emojis we use:
| Emoji | Description | Emoji Key |
|---|---|---|
| 📚 | Blogs/List of tutorials | :books: |
| 📁 | Documentation | :file_folder: |
| 🔈 | Podcast | :speaker: |
| 🛠️ | Tools/Softwares/Roadmaps | :hammer_and_wrench: |
| 📹 | Video Resource (Youtube, video course, etc...) | :video_camera: |
| 💡 | Ideas/Suggestions | :bulb: |
-
Once you're done, scroll to the bottom of the list to commit the change. Make sure the title of the commit is relevant. For example: Added How to Contribute under New Category.
-
Follow the steps to create pull request
-
Fork the repository
-
copy the url and clone the repository in your local directory using Git bash Terminal, command to clone the repo
git clone <copied url>
-
cd Open-source-practice-and-resourcesuse this command in git bash to naviage to the directory -
Make sure to create new branch by hitting
git checkout -b <your-branch-name>command -
then, Open README.md in text editor:
- In notepad =>
notepad.README.md - In VsCode =>
code README.md
- In notepad =>
Then platform is all yours, add resources/content you want but in a good way don't rush, if you find any difficulty ask in the server for help.
Don't know how to write in GitHub README.md file, have a look on link 👉 GitHub Writting
- After adding resources save the file in text editor. navigate to your Git bash terminal and hit command
git add .to add all your changes - now, you have to commit the changes. So, use
git commit -m "any-name"
- Now, its time to push your changes =>
git push origin <your-branch-name>
- Come to the repository's home page you'll, and hit on Compare and Pull request.
- And then, some checks will be performed by GitHub and if you sucessfully did it, your pull request get submitted and then, maintainers will review your request and will merge it.