Project Workflow

This page outlines a typical workflow for this repository.

Actors

• Metric lead: The person who programs and does the data analysis for an update to the metrics.
• Reviewer: The person who reviews the work of the metric lead and is ultimately responsible for ensuring that only high-quality work makes it to the main branch.
• Maintainer: The person who manages the day-to-day processes on GitHub. This is Maureen, but could be the reviewer.

Process

1. The maintainer opens a GitHub Issue for a discrete task (e.g., add new data from metric 1 or add a subgroup for metric 13). This issue should be added to the appropriate milestone and project board in the GitHub repository and tagged with the appropriate labels. The issues should include some language outlining expectations for the work.
2. The metric lead checks out from version2025 and creates a new branch called iss### (e.g., Issue 13 would lead to a branch called iss013).
3. The metric lead writes code to resolve the work outlined in the GitHub issues. Major challenges and decisions should be added as comments in the GitHub issue. The maintainer and other decisionmakers should add comments in the GitHub issue.
4. The metric lead regularly adds, commits, and pushes changes from their local Git repositories to the remote GitHub repository.
5. When the code is ready for review, the metric lead opens a pull request in GitHub and tag the reviewer and maintainer.
6. The reviewer reviews the code and provides line-by-line edits and overall feedback. This process involves checking out to the branch and running the code to ensure reproducibility. If the code is clear and correct, the reviewer approves the pull request. If the code is not clear and correct, then the reviewer should request changes. When major changes are requested, it may be appropriate to convert the pull request to a draft.
7. The maintainer merges the approved pull request. The maintainer references the pull request number in the GitHub issue and closes with comment. This way the GitHub issue and pull request are permanently linked.