Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CODEOWNERS and introduce a new team #155

Closed
wants to merge 3 commits into from

Conversation

DAKiersz
Copy link
Contributor

@DAKiersz DAKiersz commented Jul 28, 2024

In response to #136

  • Introduce a new team, FORRT Engineering, to safeguard the website when technical changes are made. They will have Admin permissions against the repository.
  • Improve CODEOWNERS by delegating responsibilities between FORRT Engineering and Team Website.
  • Team Website has Maintain permissions on the website (demoted from Admin) following the the principle of least privilege.
  • (TODO) Check/update branch policies/rulesets.

According to (1), "the last matching pattern takes the most precedence". Therefore, if technical changes are being introduced, FORRT Engineering will take precedence over Team Website. This change will allow to get the right people to review changes on the website. The more complicated/technical the changes are, the more expertise a review will need to merge it to main.

In layman's terms, this will allow a simple content change to be reviewed by Team Website and ensure that more technical changes will require a stricter review. As a result, this should be enough to justify returning to a 1 reviewer system to increase the velocity of changes.

I'm open to code suggestions if we can improve this further.

Testing

  • No website content changes.
  • (TODO) Check if CODEOWNERS changes will reflect correctly after merging.

Example Effect

PRs like #156 that consisted of a simple .md file change would only need a member of Team Website to approve.

References

(1) https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
(2) https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams

Please do not merge this before I can perform checks.

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature labels Jul 28, 2024
@DAKiersz DAKiersz linked an issue Jul 28, 2024 that may be closed by this pull request
@DAKiersz DAKiersz changed the title (Draft) Update CODEOWNERS Update CODEOWNERS and introduce a new team Jul 28, 2024
@DAKiersz DAKiersz marked this pull request as ready for review July 28, 2024 17:59
@DAKiersz DAKiersz requested a review from a team as a code owner July 28, 2024 17:59
@DAKiersz DAKiersz added the IOI grant This issue is part of the Invest in Open Infrastructure grant for Team Website label Jul 28, 2024
@helenahartmann
Copy link
Contributor

I would appreciate if we (the IOI team and team website contributors) have a meeting to discuss this before any further actions are taken or this is approved.

@bethaniley
Copy link
Contributor

Hey @helenahartmann! I haven't called an IOI meeting yet because my availability is really variable until I submit my thesis in late September.

This PR is a proposal for one way to manage the review process. Any feedback/suggestions are very welcome as comments here! 🙂

@helenahartmann
Copy link
Contributor

helenahartmann commented Jul 29, 2024 via email

@bethaniley
Copy link
Contributor

Hi Helena! Not going to lie, I meant feedback on the PR rather than project management, which is probably something which should be addressed in direct messages 😅 But I can address your points here if that's easier!

My understanding is that the IOI grant and website changes have started quite a while ago but there has not been a single meeting with all five of us in it. I have also never been informed by you, Flavio or the other grantees what is happening with the grant and what my role is.
I feel like these changes are things we should discuss as a team before we do them, over Zoom and not on a GitHub PR directly during the implementation of those changes. I also strongly feel like if there's time to implement all these changes, there should definitely be time for a meeting, if not regular ones, so we can make decisions as a team.

I think the first thing to note is that we only started working on this on 30th May and received the grant on 5th July. I've also been a bit limited in capacity for multiple reasons beyond just the PhD this month (e.g. behind-the-scenes FORRT stuff), so that's probably where the communication fell short, and I'm very sorry for that.

At present, myself and @DAKiersz are working through an audit of the website. As we've been going through the audit, Dom and I found some easy wins which don't change much about how the website functions and make contributing easier/more consistent. These are the pull requests with the "IOI grant" tag, plus a few changes on the GitHub side which are in line with FORRT's already existing processes (resources require review -> pull requests require review & don't directly edit resources -> don't push to main). We've also set up a funky project board for Team Website generally to keep track of to-dos 😎

We're working through the audit until end of September (which is roughly in line with the original four-month plan). When it's done we'll discuss the findings/recommendations and work out roles regarding implementation. You've not heard much because there isn't much to say yet, but there will be soon!

I fully understand that you currently don't have time for this because of PhD craziness, but then maybe we should stop any active changes and wait until we all have time to meet? What do you and others think?

Do you mean any active changes on the website at all? I don't think that's feasible unfortunately. Richard and Lukas have also regularly been making changes - some of which overlap with the grant, e.g. #134

@helenahartmann
Copy link
Contributor

helenahartmann commented Jul 30, 2024 via email

@DAKiersz
Copy link
Contributor Author

DAKiersz commented Jul 30, 2024

To briefly comment on the website activities. As @bethaniley said, there have been more than content changes being introduced shortly after the grant began, even by people outside of the IOI grant. Lack of meetings should not grind development to a halt, in what effectively is an open source project that can be managed in issues and PRs when time is sparse. Development is an iterative process, and there is no harm in proposing relatively small changes and having them reviewed collaboratelly as myself, Lukas W and Richard D have done. The latter should really be celebrated as a resurgence of activities on the website!

Having said that, this discussion is straying a bit outside the scope of this PR. FORRT related issues would be best to be addressed on Slack.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature IOI grant This issue is part of the Invest in Open Infrastructure grant for Team Website needs-expert-review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Exempt content folder from review requirements?
5 participants