Skip to content

Latest commit

 

History

History
73 lines (59 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

73 lines (59 loc) · 3.73 KB

Contributing Guidelines

Within this documentation, you'll find a collection of instructions designed to assist you as you contribute. We're delighted to invite contributions from anyone interested in enhancing or introducing new scripts to this repository. Your assistance is greatly appreciated, and it's important to keep in mind that every contribution, regardless of size, is valued.

Submitting Contributions👩‍💻👨‍💻

Below you will find the process and workflow used to review and merge your changes.

Step 1 : Find an issue

  • Check out the current listed issue or raise your own issue.
  • Once you're assigned a specific issue, you can start working on it.
  • Remember: Any changes to this repository has to be linked to is respective issue.

Screenshot1

Step 2 : Fork the Project

  • Fork the repository to make a copy of it on your own github profile. Make sure to have upstream as main.
$ git clone https://github.com/<your-username>/PythonScriptsHub
$ cd PythonScriptsHub
$ git remote add upstream https://github.com/Swapnil-Singh-99/PythonScriptsHub

Screenshot2

  • If you have already forked the project, update your copy before working. Screenshot3

Step 3 : Branch

Create a new branch. Use its name to identify the issue your addressing.

# It will create a new branch with name branch_name and switch to that branch 
$ git checkout -b branch_name

Step 4 : Work on the issue assigned

  • Work on the issue(s) assigned to you.
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the repository add changes to the branch you've just created:
# To add all new files to branch branch_name
$ git add .

Step 5 : Commit

  • To commit give a message describing the changes made, for the convenience of reveiwer by:
# This message will appear with the changes you have made
$ git commit -m "message"

Step 6 : Work Remotely

  • Now you are ready to push your work to the remote repository.
  • Once your work is ready and follows the Contributing Guidelines.
# To push your work to your remote repository
$ git push -u origin branch_name

Step 7 : Pull Request

  • Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution or the changes you have made.

  • Great job! Your Pull Request has been sent and the moderators will review it before merging it to main branch. 🎉 Screenshot4

Need more help?🤔

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

Tip from us😇

Your Contributions Make a Difference!

Every line of code, every idea shared, and every issue reported contributes to the growth of our repository. Your efforts bring life to this open-source community. Remember, no contribution is too small – each one is a step towards making something amazing. So, let your creativity flow and your code shine. Together, let's build something incredible!