department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
96 stars 70 forks source link

Set up codeowners notifications for Facilities in CMS repo #14060

Open jilladams opened 1 year ago

jilladams commented 1 year ago

User story

AS A: CMS contributing team I WANT: a clear indicator when changes are made that might affect my team's products SO THAT: I can ensure operational stability

Description

In the spirit of the CMS as a platform where many product teams can be contributing: we want to support a clear definition of ownership where possible. Meaning: which teams own which files and features, and should be notified to code review any changes being made to those files.

The .github/codeowners file is a mechanism that can help with this. Codeowners files articulate:

When Pull Requests make changes to files with listed owners, owners will be automatically added as Reviewers.

In vets-website & content build, this is used to help ensure that if another team modifies your team's file(s), you'll be notified and can vet the changes: https://github.com/department-of-veterans-affairs/vets-website/blob/main/.github/CODEOWNERS

In CMS, the codeowners file is not set up this way to notify PW / Fac teams yet. We should do that: https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/.github/CODEOWNERS

Tasks:

Acceptance Criteria

jilladams commented 1 year ago

I can set up the codeowner team for this in VA (or anyone may be able to). Existing CMS teams: https://github.com/orgs/department-of-veterans-affairs/teams/?query=cms

I would suggest calling this codeowner team facilities-cms and limiting this to Drupal changes. But: if it makes more sense to make it a facilities-backend, we could use that for other Lighthouse / facility Locator related things as well, if that's relevant in the CMS repo. @swirtSJW @omahane @maxx1128 can opine on that when we refine.

jilladams commented 1 year ago

I went ahead and made https://github.com/orgs/department-of-veterans-affairs/teams/facilities-cms/members, and I can edit the team name if we land on something different during refinement.

jilladams commented 1 year ago

Sister ticket for Public Websites ^ #14061. In that ticket, PW folks flagged some overarching questions / things to think through that we'd like to vet with POs in PW Refinement on Thurs 6/15 that will help determine how far down the rabbit hole we want to go as product teams vs. what should be carved off for CMS team to own as product owners, etc.

Issues/concerns

swirtSJW commented 1 year ago

I am ok with facilities-cms and we would need a facilities-fe, though for cross-functionality maybe it makes more sense to just have facilities? and have it encompass both CMS and FE? It would be a bit noisier but help us not get stuck when Max is temporarily the only FE on the team or when I am on vacation and Christian needs someone else from our team to look at it.

jilladams commented 1 year ago

We have https://github.com/orgs/department-of-veterans-affairs/teams/vsa-facilities-frontend/members already, and that's actively in use on content-build and vets-website repos today.

mmiddaugh commented 1 year ago

@xiongjaneg @jilladams I've submitted this topic for the next Scrum of Scrum sync - fyi