DR: Add decision record for Pull Request Slack notifications - hackforla/311-data GitHub Wiki
This is a record in the Decision Records on Solutions Adopted.
Issue
Problem Statement
We wanted to set up Github Pull Request (PR) notifications for Slack, in order for our team to stay up to date on new tickets and the progress of existing tickets. The initial problem statement is the lack of a streamlined approach to stay informed about Github pull request updates. Without real-time notifications, this may result in issues such as delays in PR reviews, lack of visibility on ticket progress, which in turn causes bottlenecks in development and releases.
Potential Solution
Setting up Github Pull Request notifications on Slack resolves these issues mentioned in the initial problem statement.
The Rule
Keeping the team up to date on pull requests motivates this need for this Slack feature. The PR notifications are set to run every week for a more streamlined approach on updates. This cadence provides a regular touchpoint for the team to review code, identify blockers, and improve collaboration overall.
For open pull requests, developers are expected to provide an initial review before the lead provides their review. This rule ensures that code is peer-reviewed first, promoting collaboration, feedback, and reduced burden on the lead.
Notification Schedule
The scheduled reminders are set up on the 311 Data Team's Scheduled Reminders page on Github, configured to push updates to Slack when any new pull requests emerge. This specific scheduled reminder is set to run 1x / wk on Wednesdays at 9 AM PT. These Github notifications are delivered to the #311-data-engineering channel on Slack, reaching the targeted audience of developers and reviewers.
Notification Details
Notifications are sent to Slack for the following: pull requests that require review requests, and reminders to PR authors after one review is completed.
The following pull requests are not included in the notification schedule: PRs starting with WIP, requests that are in draft mode and requests that already have 2 or more approvals.
Feasibility Determination
The setup for Github Pull Request notifications for Slack is highly feasible, requiring minimal configuration and maintenance. Github natively supported scheduled reminders for teams, and offers Slack integration without any third-party tools. The ease of implementation and maintenance is outlined on Github's Documentation: Creating a scheduled reminder for a team.
This page is part of the Decision Record section of the wiki