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

Create CODEOWNERS #876

Merged
merged 2 commits into from
Dec 20, 2023
Merged

Create CODEOWNERS #876

merged 2 commits into from
Dec 20, 2023

Conversation

naterarmstrong
Copy link
Contributor

Create a CODEOWNERS file, and add myself for cryptography slides.

I think this would be a good thing to do for any subject matter experts who are open to it. Otherwise it's hard to keep track of what content changes may be in the works.

Create a CODEOWNERS file, and add myself for cryptography slides.
@naterarmstrong naterarmstrong self-assigned this Dec 19, 2023
Co-authored-by: Joshy Orndorff <JoshOrndorff@users.noreply.github.com>
Copy link
Member

@wirednkod wirednkod left a comment

Choose a reason for hiding this comment

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

I am not sure why a CODEOWNER should exist for specific presentations. CODEOWNER will be automatically added as a reviewer in case there is a change to the material. That means that if e.g. I am the CODEOWNER for cohort #13 for polkadot, and on cohort #14 Joshy is, for the changes that Joshy will potentially do, I will be notified as an approver, which I think is not correct. I think this is not valid.

@Asamartino
Copy link
Collaborator

I agree with @wirednkod

@Asamartino Asamartino closed this Dec 20, 2023
@Asamartino Asamartino reopened this Dec 20, 2023
@naterarmstrong
Copy link
Contributor Author

naterarmstrong commented Dec 20, 2023

@wirednkod @Asamartino I think it makes sense, as contributors to PBA are often still invested in the success of the material, and this is a good way to have focused time and energy from them. A reviewer doesn't have much power, especially if they are not currently on staff. I don't see the CODEOWNER as the "owning authority" on the area as much as a way to notify people who are invested in the quality of that area when there are proposed changes.

If you, after cohort #13, are still interested in giving your opinion on the polkadot module, you should keep yourself as a code owner. Then, you will have an easy way to be notified about and give your opinion on Joshy's changes. If you don't want to be notified about Joshy's changes, you should just remove yourself as a code owner. Joshy would still add reviewers separately, who are actively involved with that upcoming iteration of PBA.

Similarly, I'm no longer part of PBA formally this time around. However, I'm still invested in these slides, as I spent a lot of time working on them, learning the material, and am the only one who actually has the experience of presenting the slides in front of a class. For that reason, I think my opinion is valuable to PBA as a whole on this material, but I don't have time to manually monitor this repository, so a codeowners file is the best solution.

@wirednkod wirednkod self-requested a review December 20, 2023 10:04
@wirednkod
Copy link
Member

@naterarmstrong thank you for the clarification. It makes sense to me - the way you put it. I do not try to indicate that CODEOWNER is really the owner of the material - and notifications make sense. It could become messy on the long run but at the end of the day, this could also serve as a "past instructors" list - where opinions are always welcome.
If this makes sense to @Asamartino or anyone responsible for merging this code - then its fine by me I guess

@Asamartino
Copy link
Collaborator

Asamartino commented Dec 20, 2023

@naterarmstrong: thank you for the clarification. I now understand and see the benefit of it.
Thank you for your suggestion :)

@JoshOrndorff
Copy link
Contributor

Another reason this is a good idea is because at some point a designer or administrator will come along to "fix" this or that big picture thing, and not realize that they are breaking something in our content.

@wirednkod wirednkod merged commit 93558ef into main Dec 20, 2023
0 of 2 checks passed
@wirednkod wirednkod deleted the nate-add-codeowners branch December 20, 2023 17:13
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