Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

93 lines (61 loc) · 4.8 KB
Raw

LinksHub contributing guidelines

Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:

⚠️IMPORTANT Note

Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.

Prerequisites

  • Open Source Etiquette: If you've never contributed to an open source project before, have a read of Basic etiquette for open source projects.

  • Basic familiarity with Git and GitHub: If you are also new to these tools, visit GitHub for complete beginners for a comprehensive introduction to them

  • Node.js is installed.

How to Contribute 🤔

  • Look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

Appending new Links 🔗

✨ You can also create issue(s) for inserting your links and someone else will take care of them.

🌟Follow these steps to get your Links added into the Hub

  • A newly created category and subcategory should be added to the data file

  • Each category has it's own folder with it's name

  • Every subcategory should be placed in it respective category folder

    i.e images should be inside Frontend folder

  • To add a new category ensure to create a folder with it's name

    i.e Resources

  • Make sure to Export the newly created json file on the index file

The subcategory object should follow this pattern

  name:'', 
  description:'',
  url:'',
  category:'', 
  subcategory:''

Details

  • name: name of the site

  • description: define what the site does in a short para

  • url: add the valid site url

  • category: could be one of the existing categories or create a new one by following the above instructions

  • subcategory: could be one of the existing categories or create a new one by following the above instructions

NOTE When adding YouTube channel link please specify language of the channel they are using to teach in for example English, Hindi, Spanish etc. In case language is NOT specified then just remove the language property.

⚠️Important

  • Do not make duplicate entries (always confirm that an entry does not exist by searching through the JSON file.
  • Ensure that your entries are error-free by double-checking before staging your changes.
  • Your entries should follow the above structure.

Making Pull Requests

  1. When you submit a pull request, several tests are automatically run as GitHub Actions. If any of these tests fail, it is your responsibility to try and resolve the underlying issue(s). If you don't know how to resolve the underlying issue(s), you can ask for help.

  2. If your pull request has merge conflicts with the main branch (GitHub checks for this automatically and notifies you), you are responsible for resolving them. You can do this by merging the main branch into your branch (git pull upstream main), and then pushing the updated branch to your fork (git push).

  3. Each pull request should contain a single logical change or related set of changes that make sense to submit together. If a pull request becomes too large or contains too many unrelated changes, it becomes too difficult to review. In such cases, the reviewer has the right to close your pull request and ask that you submit a separate pull request for each logical set of changes that belong together.

  4. Link the issue you have resolved in the Pull Request Template (e.g Closes/Fixes #99).

  5. Use Conventional commit messages for your changes.

  6. Do not re-open a pull request that a reviewer has closed.

    • Make sure to tick the "Allow edits from maintainers" box. This allows us to directly make minor edits / refactors and saves a lot of time.

Remarks ✅

If something is missing here, or you feel something is not well described, either directly create a PR or create an issue.