You can contribute to this repository very easily!
-
Get the resource you want to add ready.
-
Go to the README.
-
Click on the edit icon at the top right corner.
- 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 Content. 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:
- [How to contribute](https://github.com/shahednasser/awesome-resources/blob/master/CONTRIBUTING.md)
-
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.
-
After adding the commit title, click on propose changes and follow the steps to create a pull request.
That's it! Congratulations on making your contribution!
To contribute to the website, you need to have jekyll and its prerequisits installed. If you don't, you can check here.
After cloning the repository, in the folder run the following to install the bundles:
bundle
And then to run the website locally, run the following commands:
bundle exec jekyll serve --livereload
the --livereload option ensures the website automatically refreshes on changes to the files.
To edit the CSS of the website, you need to make edits in the files in the folder css. All the files are .sass files.
All changes to the layout should be done in _layouts folder.
To make changes to components like header or footer, changes should be made in _includes folder. You can find the list of components in the repository of the default Jekyll theme Minima