Quality Air Quality Cities

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Project Purpose

Installing

Clone the repository (https://help.github.com/articles/cloning-a-repository/)

git clone https://github.com/RTGS-Lab/QualityAirQualityCities

Inside of your project folder (after clone):

Note: the secrets file is in the .gitignore and should never be uploaded to GitHub

Development Workflow

An issue will be assigned to you via GitHub. Your workflow begins after assignment:

1. Create a branch based on the main branch with your initials and the issue number as the branch name (e.g. EB-5): git checkout -b EB-5
2. Work on the issue.
   1. Add your changes: git add .
   2. Check that your files were added as expected: git status
   3. Frequently commit your work to your local branch. Use simple, short, and descriptive messages with a verb describing the work. Include the issue number. Example: git commit -m "#5 added styling"
3. Update the CHANGELOG.md to describe your work.
4. Ensure your code is synced with the latest version of the main branch:
   1. Use this command: git pull origin main
   2. If there are no merge conflicts, the updates made to the main branch will be incorporated into your local branch automatically.
   3. If there are merge conflicts, you will need to resolve conflicts manually. Please be careful with this step so that no code is lost. Once complete, you will need to add your changes: git add . and then commit again: git commit -m "add message here"
5. Push your committed and synced branch to the remote repository on GitHub: git push origin JEB-5
6. Submit a Pull Request:
   1. Request that your branch be merged into the main branch.
   2. Name the Pull Request in this format: "Fixes #5 - Issue Description".
   3. Use keywords to automatically close issues (e.g. "Closes #5).
   4. Assign a reviewer (typically the lead developer).
7. Once your Pull Request is reviewed, address any feedback that needs to be addressed. Once you have addressed feedback, click the button to re-request review.
8. Upon approval of the Pull Request, your issue will be merged into the dev branch and you can start on a new issue.

More Git help

Check this out if your having a git of a problem... This is a more basic cheatsheet.

Infrastructure and Deployment

Authors

• Bryan Runck - Project Advisor - Senior Research Scientist (R7), GEMS Informatics Center
• Jake Ford - Developer - University of Minnesota - Geographic Information Science Program - Extentsion of Quality Air / Quality Cities
• Rob Hendrickson - Developer - University of Minnesota - Geographic Information Science Program - Extentsion of Quality Air / Quality Cities
• Lauren Roach - Developer - University of Minnesota - Geographic Information Science Program - Extentsion of Quality Air / Quality Cities
• Taylor Andersen-Beaver - Developer - University of Minnesota - Geographic Information Science Program - Extentsion of Quality Air / Quality Cities
• Ethan Bott - Developer - University of Minnesota - Geographic Information Science Program - Extentsion of Quality Air / Quality Cities