Skip to content

Commit f7bfa50

Browse files
committed
Created Github pages
1 parent 25c870b commit f7bfa50

File tree

3 files changed

+28
-29
lines changed

3 files changed

+28
-29
lines changed

docs/github/data-engineering.md renamed to docs/github/continuous-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# GitHub and Data Engineering
1+
# GitHub and Continuous Integration
22

3-
##Housekeeping
3+
## Housekeeping
44

55
- Bookmark our project’s GitHub [repository](https://github.com/cagov/caldata-mdsa-caltrans-pems)
66
- Update your [progress tracker](https://docs.google.com/spreadsheets/d/1ZuXqnR41VuaGLolKn0qq9ob1kLJ77ZZtshgWkCWfJ4c/edit#gid=0)

docs/github/project-management.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,71 +22,71 @@ These guidelines are meant to ensure that issues are created in a standardized f
2222
6. Milestone: Most DIF projects have Milestones which map to our project timelines. There is a search function which can help identify the correct milestone for the work being done. The Project Manager can help if you are not sure of the correct milestone.
2323
1. Note: If a project repo does not have milestones created (for example the ODI data-infrastructure repo) then this can be left blank.
2424
7. Due Date: Assign a due date when the work needs to be completed by, if applicable. If there is no set due date this can be left blank.
25-
8. Status:
26-
1. New: Default for new issues. If discussion is needed to clarify details about the issue leave it as New until that discussion happens (so it appears in the “New Status” Project Board view).
27-
2. Backlog: If work is not planned on this within the next 2-3 sprints, set the Status to Backlog (or Blocked if the work is blocked for any reason) and do not assign it to a sprint.
28-
3. TODO: If the issue is assigned to a sprint but work has not started yet, set the status as TODO.
29-
4. In Progress: Choose this status once work has started on the issue.
30-
5. Needs Review: Indicates that review is needed from other team members.
31-
6. Blocked: Choose this if work on the issue cannot move forward due to something outside of your team’s control, for example if waiting on another team to respond to a question.
32-
7. Paused:
33-
8. Done: Indicates the issue is completed. This status is set automatically when the issue is closed, you do not need to select it.
34-
1. Note: The correct way to close an issue is to scroll to the bottom of the issue page and choose “Close Issue”.
25+
8. Status: Assign a status on the current state of the issue. See below for Status defintions.
3526
4. Pull Requests: Add phrase “[Fixes/Closes/Resolves] #xx” to ensure the referenced issue gets closed when PR is merged
3627
1. Review “Open PRs” tab during stand up
3728
5. Make sure to fully close an issue when completed.
3829

3930

31+
## Size Definitions
4032

41-
42-
#Appendix: Github Issue Sizing and Priority Definitions
43-
44-
##Sizing
45-
46-
Tiny
33+
**Tiny**
4734

4835
- Easy task, something that can be completed in about an hour May not require issue creation but could use as a reminder to complete the task later in the sprint (if something takes less than 30 minutes, no need for an issue).
4936
- Example: Sending a follow-up email
5037

51-
Small
38+
**Small**
5239

5340
- A task that can be completed in one day
5441

55-
Medium
42+
**Medium**
5643

5744
- A task that can be completed in about a week
5845
- More complex but still straightforward to complete
5946

60-
Large
47+
**Large**
6148

6249
- A task that can be completed in 2 or more weeks
6350
- Increased complexity, may require slower manual work or unknowns that require research and discovery
6451

65-
X-Large
52+
**X-Large**
6653

6754
- Tasks that may take a month or longer to complete
6855
- Consider breaking up into sub-tasks if appropriate, or create a meta-issue when there are dependencies
6956
- Example: Building a data model
7057

71-
##Priority
72-
Urgent
58+
## Priority Definitions
59+
60+
**Urgent**
7361

7462
- Top priority / emergency
7563
- Putting everything else on backburner
7664
- Aiming for completion ASAP
7765
- Due Date assigned must be kept
7866

79-
High
67+
**High**
8068

8169
- Important, goal is to complete this sprint
8270
- Due Date should be kept as much as possible
8371

84-
Medium
72+
**Medium**
8573

8674
- Less important than High, aim to complete within 2-4 sprints
8775
- Due Date is a target but OK to push back
8876

89-
Low
77+
**Low**
9078

9179
- Work on as time allows, may leave in backlog
9280
- Due Date not required or kept as a reminder to check back and move out of backlog by a certain point in time
81+
82+
## Status Definitions
83+
84+
1. **New**: Default for new issues. If discussion is needed to clarify details about the issue leave it as New until that discussion happens (so it appears in the “New Status” Project Board view).
85+
2. **Backlog**: If work is not planned on this within the next 2-3 sprints, set the Status to Backlog (or Blocked if the work is blocked for any reason) and do not assign it to a sprint.
86+
3. **TODO**: If the issue is assigned to a sprint but work has not started yet, set the status as TODO.
87+
4. **In Progress**: Choose this status once work has started on the issue.
88+
5. **Needs Review**: Indicates that review is needed from other team members.
89+
6. **Blocked**: Choose this if work on the issue cannot move forward due to something outside of your team’s control, for example if waiting on another team to respond to a question.
90+
7. **Paused**:
91+
8. **Done**: Indicates the issue is completed. This status is set automatically when the issue is closed, you do not need to select it.
92+
1. Note: The correct way to close an issue is to scroll to the bottom of the issue page and choose “Close Issue”.

mkdocs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,8 @@ nav:
6161
- dbt Performance: dbt/dbt-performance.md
6262
- dbt Snowflake Project: dbt_docs_snowflake/index.html
6363
- GitHub:
64-
- GitHub Overview: learning/git.md
6564
- GitHub Project Management: github/project-management.md
66-
- GitHub Data Engineering: github/data-engineering.md
65+
- GitHub Continuous Integration: github/continuous-integration.md
6766
- Data:
6867
- Building Footprints: data/footprints.md
6968
- Learning:

0 commit comments

Comments
 (0)