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 CONTRIBUTING.md #6453

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Update CONTRIBUTING.md #6453

merged 2 commits into from
Sep 25, 2024

Conversation

BlackYps
Copy link
Contributor

This updates the contents of CONTRIBUTING.md and should enable everyone to make good pull requests, find reviewers and to review PRs of others.

@BlackYps BlackYps marked this pull request as ready for review September 17, 2024 09:48
@BlackYps BlackYps added the area: documentation related to documentation to preserve knowledge and practices label Sep 17, 2024
@Garanas
Copy link
Member

Garanas commented Sep 18, 2024

It may be interesting to use the Pizza CLI (yes), to generate an accurate CODEOWNERS.MD file of the last year. That integrates with GitHub if I am not mistaken, that way people get more accurate suggestions. It is also where other GitHub users would expect the code owners to be listed.

If we then document the process, we can update the file every 6 months or so. We may even be able to automate it with a Workflow that creates a new pull request every 6 months.

An interesting article about it:

@BlackYps
Copy link
Contributor Author

What halts me from using the code owners functionality is this (cited from the article you linked):

Code owners are automatically requested for review when someone opens a pull request that modifies code that they own

This seems terribly annoying in the long run.

@BlackYps
Copy link
Contributor Author

Pinging the other people that are mentioned in the file, so they are aware
@speed2CZ @relent0r @MadMaxFAF @The-Balthazar

@Garanas
Copy link
Member

Garanas commented Sep 22, 2024

What halts me from using the code owners functionality is this (cited from the article you linked):

Code owners are automatically requested for review when someone opens a pull request that modifies code that they own

This seems terribly annoying in the long run.

You're right, that does sound a little annoying.

Copy link
Contributor

@lL1l1 lL1l1 left a comment

Choose a reason for hiding this comment

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

You can also add me to the blueprints section, as I understand that part is about understanding what all the blueprint values can do for a unit/weapon?

@relent0r
Copy link
Contributor

Silly question but what defines a code owner? is it just anyone that's committed to the file in question?

@lL1l1
Copy link
Contributor

lL1l1 commented Sep 22, 2024

Code owners are manually added to the CODEOWNERS file, so how ownership is given is up to us. The purpose of code owners is to automatically request reviews from knowledgeable people when a PR changing certain files is opened. You could determine who is knowledgeable by commits, sure.

@The-Balthazar
Copy link
Contributor

You can put me down for sim and bps.

@BlackYps
Copy link
Contributor Author

You can also add me to the blueprints section, as I understand that part is about understanding what all the blueprint values can do for a unit/weapon?

Yes, that is correct

@BlackYps
Copy link
Contributor Author

I will give everybody triage access that doesn't yet have access to the repo. This is required so you can actually be requested for review.

@Garanas
Copy link
Member

Garanas commented Sep 25, 2024

@BlackYps if I am not mistaken then there is a GitHub team role specifically for that purpose. You could add the users to that role, instead of adding them directly to the repository.

@BlackYps
Copy link
Contributor Author

BlackYps commented Sep 25, 2024

Found it. But I don't have permissions to edit these teams. I think we forgot to have a look at these team permissions when we transferred the team lead position.

@BlackYps BlackYps merged commit c3fc75d into develop Sep 25, 2024
3 checks passed
@BlackYps BlackYps deleted the contributing.md branch September 25, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation related to documentation to preserve knowledge and practices
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants