CONTRIBUTING.md

How can I contribute to this awesome initiative?

Setup Guide for contributors

(1) Clone the se22 repository and enter into it

git clone https://github.com/mithildani/se22.git
cd se22

(2) Create then activate a virtual environment

# On Windows, the commands may be slightly different. For more details, see
# https://docs.python.org/3/library/venv.html#creating-virtual-environments
python3 -m venv venv
source venv/bin/activate

(3) Install the test requirements and the project

$ python3 install -r requirements.txt

Folder structure and File naming Conventions TBD