Skip to content

Latest commit

 

History

History
269 lines (182 loc) · 13.2 KB

README.md

File metadata and controls

269 lines (182 loc) · 13.2 KB
Raw

ResourceHub Banner

Open Source Love Awesome Contributors Welcome First Contributors PR:s Welcome Issues Stars Forks MIT License Contributor Covenant

Table of Contents

What is ResourceHub

ResourceHub is an open-source project that serves as a one-stop repository of valuable resources curated by the amazing contributors in the community

You can contribute with helpful resources you've discovered on the internet and share them with us!

Categories

Here is a list of the currently available categories of the project:

Technologies

ResourceHub is built using the following technologies:

  • Frontend: HTML, CSS, JS
  • Deployment: Vercel

Website URL: ResourceHub

Organization

Organization ResourceHub is participating in GirlScript Summer of Code (GSSoC), an annual open-source program by the GirlScript Foundation. GSSoC promotes gender diversity and inclusion in tech by enabling participants to contribute to various projects under expert mentorship. We are excited to collaborate with talented individuals and advance our project through this initiative.

How to contribute

Read CONTRIBUTING.md and create your fork of this repository before submitting any contributions. Expand the following section for a quick guide on how to create a fork:

How to Fork this Repo and Submit a Pull Request (PR)

1. Create a Fork

Click the Fork button at the top right of this repository to create your copy.

2. Clone Your Fork

Clone the forked repository to your local machine by following these steps:

  1. Open the forked repository in your GitHub account.
  2. Click on the Code button.
  3. Select the HTTPS option in the Local tab.
  4. Click the 'Copy to clipboard' icon.

Open a terminal and run the clone command followed by the URL you just copied. For example:

git clone https://github.com/jfmartinz/ResourceHub.git

3. Create a branch

Go to the repository directory on your computer using the cd command. For example:

cd ResourceHub

Create a new branch and switch to it using the git checkout command. Give it a name that is descriptive of the changes you are introducing.

git checkout -b 'new-branch-name'

Note: Replace 'new-branch-name' with the branch name of your choice.

4. Make your changes

Navigate to the category where you want your resources to be added. Once you've identified the appropriate category and have your resource in mind, proceed to make the necessary changes within that specific category.

5. Stage and commit your changes:

  • Stage your changes using the git add . command.
  • Commit your staged changes using the git commit command.
  • Use a descriptive commit message that explains the purpose of your changes. For example:
git add .
git commit -m "Your descriptive commit message here"

Note: Replace "Your descriptive commit message here" with a concise and informative message.

6. Push your changes:

Pushing is how you transfer commits from your local repository to a remote one. To push use the command git push origin followed by your branch name.

git push origin 'your-branch-name'

Note: Replace 'your-branch-name' with the name of your branch.

5. Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & Pull Request button. Click on it to submit your PR.

Congratulations on successfully submitting your PR to our project! 🎉

Please consider sharing this repository with other developers to help increase its visibility and reach. 👍

Alternatively use GitHub Desktop

1. Open GitHub Desktop

Launch GitHub Desktop and log in to your GitHub account.

2. Clone the Repository

If you haven't cloned the ResourceHub repository yet, you can do so by

  1. Clicking on the "File" menu and selecting "Clone Repository."
  2. Choose the ResourceHub repository from the list of repositories on GitHub and clone it to your local machine.

3. Switch to the Correct Branch

  1. Ensure you are on the branch that you want to submit a pull request for.
  2. If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

4. Make the desired changes

Make your changes to the code or files in the repository using your preferred code editor.

5. Commit Changes

  1. In GitHub Desktop, you'll see a list of the files you've changed.
  2. Check the box next to each file you want to include in the commit.
  3. Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively.
  4. Click the "Commit to " button to commit your changes to the local branch.

6. Push Changes to GitHub

After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

7. Create a Pull Request

  1. Go to the GitHub website and navigate to your fork of the ResourceHub repository.
  2. You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

8. Review and Submit

  1. On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  2. Once you're satisfied, click the "Create pull request" button to submit your pull request.

9. Wait for Review

Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the ResourceHub repository.

Congratulations on successfully submitting your PR to our project! 🎉

If you find ResourceHub useful, please consider giving it a star! ⭐️

Our Contributors 🤝

License 🛡️

ResourceHub is licensed under the MIT License - see the LICENSE file for details.

If you find this repository useful, please consider giving it a ⭐️