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

docs: A new maintainer should be aware and aligned with their repo's CCs #470

Merged
merged 3 commits into from
Feb 29, 2024

Conversation

feanil
Copy link
Contributor

@feanil feanil commented Feb 22, 2024

No description provided.

@jristau1984
Copy link

I suggest this be a two way statement, and not just for new maintainers. Thanks for this!

source/developers/how-tos/maintain-a-repo.rst Outdated Show resolved Hide resolved
source/developers/how-tos/maintain-a-repo.rst Outdated Show resolved Hide resolved

For any new CCs that might get added to your repo, you will have the
opportunity to vote on their nomination and decide whether they should get
access.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link to the description of the nomination process? Also we say in the maintainers OEP that it's actually a responsibility to participate in this process.


This is a more difficult item to test but a repo that you take on may already
have other CCs that have merge rights on it. You should review which CCs have
write access to your repo on the `CCs Wiki Page`_. You should communicate with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I searched this page for dashboard and thought there were no CC's yet. 😅

I'm not opposed to the all_frontends group, and it makes sense in particular for the translations / shared infrastructure, but would it be possible to have a more reliable way to look up CC's? e.g. can I see them somewhere in github?

Alternatively we could just have a more explicit handoff process. Like, when you transition ownership, make a discourse post (maybe with a template where you tag all the CCs) about it and have a conversation with people about work in flight.

Copy link
Contributor Author

@feanil feanil Feb 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a note about it now, long term it would be nice to just be able to get a list given a repo.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it could be a good idea to define what groups like all_frontends at the top of the wiki page so your ctl-f would hit on your repo. It may be difficult to keep in sync if, for example, we added a new MFE but forgot to update the wiki page. IDK. All imperfect solutions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we provide, at the top of the core contributors page, links to all the github groups that we create for core contributors. for example I see three already for frontend.

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ALSO, Axim admins can just tell you which groups have write access to your repo. Very possibly the easiest/best course of action is to just file an Axim request ticket. For example if I go into settings on frontend-app-profile I see this list (which is a part of the whole)

image

.. warning::

If the repo in question is an MFE, devs might have access to it via the
`frontend-all` group. Be sure to check for that.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this is entirely sufficient, I could see relatively soon adding groups for data repos and perhaps more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we list the set of groups at the top of the CC wiki paged so that people can be aware of them. Then this could be a more generic message to look out for groups?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, I didn't see you suggesting the same thing above. Cool, I'll update the wiki page since we had the same idea 😄

@feanil feanil force-pushed the feanil/maintainer_cc_checkin branch from 88a3439 to f1737a4 Compare February 28, 2024 18:28
@feanil feanil requested a review from sarina February 28, 2024 18:28
@feanil feanil merged commit 15e8c83 into main Feb 29, 2024
2 checks passed
@feanil feanil deleted the feanil/maintainer_cc_checkin branch February 29, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants