Py-SCRIPTS

Contribute to this documentation

Thank you for your interest in this project!

• Introduction
• How to contribute
• Contribute on
• Author

Introduction

This project aims to simplify and guide the learners towards the world of automation. This repository consist a list of awesome Terminal-Based script projects which can be accesssed from the scripts directory. The detailed description about each of the scripts can be found in their respective readme files. So if you are looking to make some exciting open source contribution using python , you are at the right place.
If you don't have git on your machine, install it

Tech Stack

---

🧑🏿‍💻 How to contribute

This repository accepts all kinds of script contributions. Before making a contribution please make sure you have gone through our contributing guidelines.

1️⃣ Fork this repository to your account

• Fork this repository by clicking on the fork button on the top of this page.
• This will create a copy of this repository in your account.

2️⃣ Clone the Repository

• Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

• Open a terminal and run the following git command:

git clone https://github.com/DSC-CETB/Py-Scripts.git

3️⃣ Add a remote (upstream) to original project repository

cd Py-Scripts
git remote add upstream https://github.com/DSC-CETB/Py-Scripts.git

4️⃣ Now synchronize your forked repo

• It will help you to keep your forked repo updated with the original repo

git checkout main
git fetch upstream
git merge upstream/main
git push origin main

5️⃣ Now create a new branch

• Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)

6️⃣ Make necessary changes and commit those changes

• Open the folder in your local code editor and add your changes or modifications

• If you go to the project directory and execute the command git status, you'll see there are changes.

• After making changes or modification on to your code locally, you need to add these files to the staging area. Add those changes to the branch you just created using the git add command:

git add --all

• Once files added, you need to commit the changes to with an appropriate commit message using the git commit command:

git commit -m "<your-message>"

7️⃣ Push changes to GitHub

• After committing the changes, you need to push the changes to master repo using git push command:

git push origin <your-created-branch-name>

replacing <your-created-branch-name> with the name of the branch you created earlier.

8️⃣ Submit your changes for review

• Once you push the changes to your repository, the Compare & pull request button will appear in GitHub.
  
• Go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button

• Type a proper description and give the PR an appropriate title.
• Finally, Open a pull request by clicking the Create pull request button.

Soon we'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.

Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll encounter often as a contributor!

Contribute on

You can start contributing to this project either by,

• Adding your own python automation scripts
  or
• Adding some more features to the already existing scripts(FILE_Organiser.py,PDF_Merger,URL_Short)

Author

$Yagyandatta

Thanks for your Contribution!!