Contribute Instructions

🔱 First, Fork This Repo by clicking here .

📋 Second, Clone your version for local dovelopment

$ git clone https://github.com/YourUserName/myCity.git

📝 Third, Create a new branch starting with your username

$ git checkout -b ChrisBarnes2000
or
$ gco -b ChrisBarnes2000

⚙️ Fourth, Configure Your Local Environment

Create a virtual environment to isolate and container-ize our development server.

$ virtualenv env && source venv/bin/ativate
$ pip install --upgrade pip && pip install -r requirements.txt

🖋️ Remember to Document your Changes.

🛠️ Fifth, Make Modificaitons on your new branch ⚒️

Run Locally, by Building the image to run the container on docker

$ Flask Run

Test it out at http://localhost:5000.

🛑 Stop The Local Server ❌

$ command+C or ⌘C

🧰 Command Short Cuts used below

Description	Short Cut	Regular
Add all changes	ga .	git add .
checkout branch	gco	git checkout
checkout master branch	gcm	git checkout master
merge changes to master	gm	git merge Branch
push to origin	gp	git push

💻 Local Branch Development

Create/Switch to branch and work on it there..
```
$ gco <Branch-Name>
```
Edit Stuff and Test locally
add, commit, & Push to that branch

Use tags when committing ga .;gcmsg "[function] description"
- [Add]: File or Function XYZ
- [Fix]: Typo or Function or explaination, etc
- [Pull]: From Whom or What Branch For What Reason
- [Refactor]: File or Function XYZ For Reason LMNOP
- [Remove]: File or Function XYZ For Reason LMNOP
- [Update]: File or Function XYZ For Reason LMNOP
```
$ git push origin <Branch-Name>
```
Switch to master
```
$ gcm
or 
$ git checkout master
```

Merge with master

$ gm <Branch-Name>
or
$ git merge <Branch-Name>

Push
```
$ gp
or
$ git push
```

🔁🔁 Repeat 🔁🔁 branching and update your team and progress tracker / Rubric-Scoring 🔁🔁