Skip to content

Latest commit

 

History

History
136 lines (104 loc) · 6.42 KB

Contributing.md

File metadata and controls

136 lines (104 loc) · 6.42 KB
Raw

📜 Contributing Guidelines: This document will guide you through the process of contributing to our repository. We value the time and effort of our contributors, and we strive to create an inclusive and collaborative community. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small. Please note we have a code of conduct please follow it in all your interactions with the project.

🔁Steps to Contribute

  1. Fork the repository: Click on the "Fork" button at the top-right corner of this page. This will create a copy of this repository in your account.

  2. Clone the repository: After forking, clone the repository to your local machine using the following command in your terminal:

    git clone https://github.com/<your-github-username>/SpoonShare.git

  3. Change the directory: Change to the repository directory on your computer (if you are not already there):

 cd .\SpoonShare\
  1. Add a remote upstream: Set up a remote upstream to the original repository by running the following command in your terminal:
  git remote add upstream https://github.com/<original-owner>/SpoonShare/
  1. Create a new branch: Switch to a new branch for your contributions:
  git switch -c <your-branch-name>

  1. Make changes: Start making your changes to the source code.

  2. Add your changes: Stage your changes for commit:

  git add <changed-file1> <changed-file2> ...

or simply run

  git add .
  1. Commit your changes: Commit your changes with a descriptive message:
  git commit -m "<your-commit-message>"
  1. Push your changes: Push your changes to the forked repository:
  git push -u origin <your-branch-name>
  1. Create a Pull Request: Go to the GitHub repository, select your branch, and click on the "New pull request" button to create a new pull request.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the ResourceHub repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the ResourceHub repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • 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 Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. 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:

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

  1. Review and Submit:

    • 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.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. 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.

📈 Development Workflow When working on the project, please follow these guidelines:

  1. Always work on a new branch for each separate issue or feature.
  2. Keep your branch up to date with the main repository's master branch.
  3. Write clear and descriptive commit messages.
  4. Test your changes thoroughly before submitting a pull request.
  5. Keep discussions polite and respectful.

Need Help regarding some basics? 🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

  1. Ensure that you have self reviewed your code.
  2. Make sure you have added the proper description for the functionality of the code.
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

✅ Code Reviews ✅

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.
  • Don't be afraid to ask questions about the code's intent or approach.
  • Once the identified issues are addressed, provide approval for the code to be merged

⭐️ Support the Project

  • If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.
  • ☘️Spread the word about the project on social media, developer forums, or any relevant community platforms.
  • 🚀 Thank you for your valuable contribution and for being a part of the Clueless Community! Together, we can make a difference. 🚀

Happy Contribution : Thanks for making a difference!🔥🔥