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.
This commit is contained in:
Ketan Chowdhury committed 2022-07-21 10:26:08 +05:30
1 parent 550eb16fea
commit ffda658790
2 files changed
+22 -1

No files matched your search

+20 -1
View File
@@ -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 #\<issue number\>") 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
+2
View File
@@ -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()