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()