From ffda658790004809473c04ded167e94cf0185bb4 Mon Sep 17 00:00:00 2001 From: Ketan Chowdhury Date: Thu, 21 Jul 2022 10:26:08 +0530 Subject: [PATCH 1/3] Edited main.py and CONTRIBUTING.md Added a line to code to the shutdown function to inform the user of exiting the program upon calling the function. And, Also wrote a section of CONTRIBUTING.md to help beginner developers to setup their fork of the repo as many beginners to github might not know how to setup this up. --- CONTRIBUTING.md | 21 ++++++++++++++++++++- main.py | 2 ++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca1c7cb..7f59dfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,6 +105,25 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/elebum You development environment should follow the requirements stated in the [README file](README.md). If you are not using the specified versions, **please reference this in your pull request**, so reviewers can test your code on both versions. +#### Setting up your development repository + +These steps are only specified for beginner developers trying to contribute to this repository. +If you know how to make a fork and clone, you can skip these steps. + +Before contributing, follow these steps (if you are a beginner) + +- Create a fork of this repository to your personal account +- Clone the repo to your computer +- Make sure that you have all dependencies installed +- Run `python3 main.py` to make sure that the program is working +- Now, you are all setup to contribute your own features to this repo! + +Even if you are a beginner to working with python or contributing to open source software, +don't worry! You can still try contributing even to the documentation! + +("Setting up your development repository" was written by a beginner developer themselves!) + + #### Making your first PR When making your PR, follow these guidelines: @@ -114,7 +133,7 @@ When making your PR, follow these guidelines: - You link any issues that are resolved or fixed by your changes. (this is done by typing "Fixes #\") in your pull request - Where possible, you have used `git pull --rebase`, to avoid creating unnecessary merge commits - You have meaningful commits, and if possible, follow the commit style guide of `type: explanation` -- Here are the commit types: +- Here are the commit types: - **feat** - a new feature - **fix** - a bug fix - **docs** - a change to documentation / commenting diff --git a/main.py b/main.py index adc478d..a419e45 100755 --- a/main.py +++ b/main.py @@ -62,6 +62,8 @@ def run_many(times): def shutdown(): print_markdown("## Clearing temp files") + # Informs the user of exiting the program + print("Exiting...") cleanup() exit() From 81b20f5e13ad990d11b090a832b28cd20c140239 Mon Sep 17 00:00:00 2001 From: Jason Date: Thu, 21 Jul 2022 21:23:41 -0400 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f59dfd..8fc7d3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,4 @@ + # Contributing to Reddit Video Maker Bot 🎥 Thanks for taking the time to contribute! ❤️ @@ -115,7 +116,7 @@ Before contributing, follow these steps (if you are a beginner) - Create a fork of this repository to your personal account - Clone the repo to your computer - Make sure that you have all dependencies installed -- Run `python3 main.py` to make sure that the program is working +- Run `python main.py` to make sure that the program is working - Now, you are all setup to contribute your own features to this repo! Even if you are a beginner to working with python or contributing to open source software, From 43f4af9b06c7bf8396bde00b3cccb7ffb171fe8f Mon Sep 17 00:00:00 2001 From: Jason Date: Fri, 22 Jul 2022 08:56:51 -0400 Subject: [PATCH 3/3] Update main.py Put the format correctly --- main.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/main.py b/main.py index a419e45..6725540 100755 --- a/main.py +++ b/main.py @@ -62,9 +62,8 @@ def run_many(times): def shutdown(): print_markdown("## Clearing temp files") - # Informs the user of exiting the program - print("Exiting...") cleanup() + print("Exiting...") exit()