Skip to content
This repository has been archived by the owner on May 4, 2024. It is now read-only.

Latest commit

 

History

History
93 lines (56 loc) · 5.1 KB

CONTRIBUTING.md

File metadata and controls

93 lines (56 loc) · 5.1 KB
Raw

Contributing Guidelines

ℹ️ Please follow the code of conduct in all the interactions with Awesome Illustrations 4Projects and your fork repository.

This repository welcomes all contributions and corrections. Before contributing, please make sure you have read the guidelines below.
If you're new to git and/or GitHub, we suggest you go through the GitHub Guides.

  1. Fork this repository

  2. (Optional) Clone the fork via git

    • Using SSH

      git clone --filter=tree:0 git@github.com:Anmol-Baranwal/Hack-Your-Growth.git

    • Using HTTPS

      git clone --filter=tree:0 https://github.com/Anmol-Baranwal/Hack-Your-Growth.git

    • Using GitHub CLI

      gh repo clone Anmol-Baranwal/Hack-Your-Growth -- --filter=tree:0

  3. Create a new branch from the latest branch main

  4. Start editing file(s) on the new branch

  5. Commit and push to the new branch

  6. Make a pull request towards the original repository (Anmol-Baranwal/Hack-Your-Growth)

Pull Request Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Search the list of resources to make sure you don't add a duplicate.
  • Make sure someone else has not already pulled the request for the changes you wish to do.
  • The Resource should be in the relevant category.
  • Any changes or suggestions to the existing content or repository are welcomed.

You don't need to worry as I will request the changes needed in the pull request before merging.

Guideline to Add Resource

You can add different set of resources according to your needs.

  1. First, make an issue using the recommended template (Add New Resource) of the reource you wish to add. Then raise a PR, I would gladly merge a pull request.

  2. If you want to add this resource yourself, then write Yes in Contributing while making the issue otherwise write No

  3. To add a Resource, you can read the detailed instructions here

Do you wish to add a Category?

  • This repository is created mainly to aid developers or someone who is in the field of tech. So, make sure the category is not something out of scope.

  • Restrict long words of category that are too general like reactJS courses, since there are 1000s of them and would potentially flood the repository. Rather, it would be efficient to add ReactJS courses with vast number of students enrolled and industry oriented for projects.

  • Even, I don't know which category would be more relevant, so make sure to create an issue to take opinions.

Additional Information

  • If you want to make an issue of multiple resources at once. Make a ToDo list task in a single issue, for example see here

  • Description

    • When adding a resource, check the description with Grammarly or with any other grammar checker to avoid grammatical mistakes.

    • Make sure to not stretch the description to a very long length, even 15 words would be enough if it states the purpose.

    • Add an appropriate description for someone to quickly grasp information about the resource.

Feedback:

Or you can create an issue where you can mention some new ideas or suggestions that will enhance this repository✨.