Skip to content

Getting Started

Heather Baier edited this page Mar 26, 2024 · 6 revisions

Reading the tasks chart

Columns
Title: Description of the task
Status:

  • Backlog: Not ready to be taken
  • Ready: Available for taking
  • In Progress: Assignee is working on it
  • In Review: Heather is checking
  • Done: Finito!

Assignees: Person assigned to/working on the task
Estimate: Number of hours estimated to complete
Linked Pull Request: The pull request submitted when the task is finished
Reviewers: Heather
Repository: Should generally be GEO

Setup

  1. Open a terminal and clone the repository to your computer: git clone https://github.com/heatherbaier/geo
  2. Download the gh clinet brew install gh
  3. Authenticate gh gh auth login

Process

1. Look over tasks and see what you want to do

The first thing you will look at is the task name. There are 3 main task types:

  • Create ID's
    • Description: This will involve creating an output file for the database called _geo as well as a shapefile and zipfile. This is the foundational geographic information for a school's countries and this will add the country to our database. It's not a hard task, but you'll need to load the files into QGIS to ensure the coordinates are accurate.
    • Script example: https://github.com/heatherbaier/geo/blob/master/scripts/geo/bol_geo.py
    • General time estimate 1-4 hours (depends on how much cleaning the coordinates need)
    • DB tables: & _geo
    • Final table columns: geo_id,deped_id,school_name,address,adm0,adm1,adm2,adm3,longitude,latitude
  • Create personnel data
    • Description: This will entail creating the _personnel file for the database. You'll match files based on geo_id and gather relevant teacher and student data for all years available.
    • Script example: https://github.com/heatherbaier/geo/blob/master/scripts/personnel/nig_personnel.py
    • General time estimate 1-2 hours
    • DB tables: _personnel
    • Final table columns: geo_id,year,deped_id,total_teacher_male,total_teacher_female,total_teachers,total_student_male,total_student_female,total_student_enrollment

2. Assign yourself to a task Click the dropdown arrow in the Assignee column and assign yourself to the task!

**3. Mark the task as 'In Progress' Click the dropdown arrow in the Status column and switch it to 'In Progress'

3. Complete the task

  • Check to see if there are any branches already associated with the issue: if there are, reach out to the team and see if someone has already done work on it.
    • gh issue develop --list <issue_numer>
  • Create a branch for the issue based on the current master branch and switch to it
  • gh issue develop <issue_numer> --base master --checkout

**3. Create a Pull Request when finished When you are finished with a task, first click the dropdown arrow in the Status column and switch it to 'In Review'

Next, create a pull request with your changes following the instructions below:

Screenshot 2024-03-26 at 1 48 45 PM
  1. Navigate to the

Clone this wiki locally