Introduce MAINTAINERS.md #1560

pavelkumbrasev · 2024-11-13T13:02:49Z

Description

This document introduces public roles for the project and the process to achieve one of these roles.

Other information

@kboyarinov @isaevil @sarathnandu @dnmokhov

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

pavelkumbrasev · 2024-11-13T13:06:44Z

For some reason GitHub cannot use colors for md files.
This is how VS code renders it:

And this is GitHub:

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

isaevil · 2024-11-14T08:17:42Z

MAINTAINERS.md

+| Can suggest Milestones during planning                                                                                                      |            ✓            |            ✓           |            ✓            |
+| Can choose Milestones for specific component                                                                                                |            ✗            |            ✓           |            ✓            |
+| Paticipate in project's Milestones planning                                                                                                 |            ✗            |            ✗           |            ✓            |


I am confused here a little bit. How can Contributor suggest milestones during planning but at the same time they cannot participate in project's planning?

There is also a typo:
Paticipate -> Participate

I am confused here a little bit. How can Contributor suggest milestones during planning but at the same time they cannot participate in project's planning?

Technically, during a PR submission a Contributor can say smth like "I'd like this fix to be included into the next oneTBB release".

@omalyshe
But it does not mean we will actually will do it for the next release.

What I wanted to say here: different stages of influence of decision making.
E.g. contributor can suggest something != we actually will consider this for the next release.

Is the verb "choose" in "choose Milestones" is too strong for Code Owner if you don't want to imply that Code Owners participate in Milestones planning.

@omalyshe But it does not mean we will actually will do it for the next release.

Yes, I agree with this. Suggestions from contributors will be considered but not necessarily included in the release.

isaevil · 2024-11-14T08:26:00Z

MAINTAINERS.md

+The process of becoming a Code Owner is:
+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file
+including name, Github username, and affiliation.
+2. At least two specific component Maintainers approve the PR.


Well, there is only one Maintainer right now in oneTBB Core component, for example. How is it possible for "at least two" Maintainers to ACK such PR? :)

Also it states earlier that Code Owners "participate in promotions of Code Owners", how do they participate if that cannot approve these. I think maybe "specific component Maintainer" -> "Code Owners of that component or Maintainers"

That was an error, code-owners cannot participate in promotion process

isaevil · 2024-11-14T08:27:22Z

MAINTAINERS.md

+| Konstantin Boyarinov  | @kboyarinov           | Intel Corporation | Code Owner |
+| Aleksei Fedotov       | @aleksei-fedotov      | Intel Corporation | Code Owner |
+| Ilya Isaev            | @isaevil              | Intel Corporation | Code Owner |
+| Sarath Nandu R        | @sarathnandu          | Intel Corporation | Code Owner |
+| Dmitri Mokhov         | @dnmokhov             | Intel Corporation | Code Owner |
+| Michael Voss          | @vossmjp              | Intel Corporation | Maintainer |
+| Alexey Kukanov        | @akukanov             | Intel Corporation | Code Owner |
+| Pavel Kumbrasev       | @pavelkumbrasev       | Intel Corporation | Code Owner |


Maybe sort this list by Role?

I suggest sorting the list by name as those are usually unique and does not depend on the account ID in case the project would move to another platform someday.

Also, what about e-mail addresses of people in the list? Do we want to list them here as well so that anyone interested can reach out to them in case of a need or we think that tagging a person in a GitHub Issue is enough?

MAINTAINERS.md

Co-authored-by: Ilya Isaev <ilya.isaev@intel.com>

MAINTAINERS.md

omalyshe · 2024-11-14T10:36:04Z

MAINTAINERS.md

+| Can suggest Milestones during planning                                                                                                      |            ✓            |            ✓           |            ✓            |
+| Can choose Milestones for specific component                                                                                                |            ✗            |            ✓           |            ✓            |
+| Paticipate in project's Milestones planning                                                                                                 |            ✗            |            ✗           |            ✓            |


I am confused here a little bit. How can Contributor suggest milestones during planning but at the same time they cannot participate in project's planning?

Technically, during a PR submission a Contributor can say smth like "I'd like this fix to be included into the next oneTBB release".

MAINTAINERS.md

vossmjp · 2024-11-19T00:51:51Z

MAINTAINERS.md

+| Follow Contribution Guidelines                                                                                                              |            ✓            |            ✓           |            ✓            |
+| Enforce Contribution Guidelines                                                                                                             |            ✗            |            ✓           |            ✓            |
+| Co-own component or aspect of the library,<br>  including contributing: bug fixes, implementing features,<br> and performance optimizations |            ✗            |            ✓           |            ✓            |
+| Co-own on technical direction of component or<br> aspect of the library                                                                     |            ✗            |            ✗           |            ✓            |


Code-owners do not co-own technical direction of their specific component?

I'm not sure if we expect this from the code-owners.

MAINTAINERS.md

vossmjp · 2024-11-19T00:56:22Z

MAINTAINERS.md

+| Can suggest Milestones during planning                                                                                                      |            ✓            |            ✓           |            ✓            |
+| Can choose Milestones for specific component                                                                                                |            ✗            |            ✓           |            ✓            |
+| Paticipate in project's Milestones planning                                                                                                 |            ✗            |            ✗           |            ✓            |


Is the verb "choose" in "choose Milestones" is too strong for Code Owner if you don't want to imply that Code Owners participate in Milestones planning.

vossmjp · 2024-11-19T01:01:54Z

MAINTAINERS.md

+The process of becoming a Code Owner is:
+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file
+including name, Github username, and affiliation.
+2. At least two specific component Maintainers approve the PR.


Also it states earlier that Code Owners "participate in promotions of Code Owners", how do they participate if that cannot approve these. I think maybe "specific component Maintainer" -> "Code Owners of that component or Maintainers"

vossmjp · 2024-11-19T01:03:44Z

MAINTAINERS.md

+  * Commits to being responsible for that specific area.
+
+The process of becoming a Code Owner is:
+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file


Can a contributor nominate themselves?

Can a contributor nominate themselves?

I think it is acceptable.

I'm not sure.

Co-authored-by: Mike Voss <michaelj.voss@intel.com>

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

omalyshe

Please also address earlier comments.

omalyshe · 2024-11-19T09:33:42Z

MAINTAINERS.md

+| Can suggest Milestones during planning                                                                                                      |            ✓            |            ✓           |            ✓            |
+| Can choose Milestones for specific component                                                                                                |            ✗            |            ✓           |            ✓            |
+| Paticipate in project's Milestones planning                                                                                                 |            ✗            |            ✗           |            ✓            |


@omalyshe But it does not mean we will actually will do it for the next release.

Yes, I agree with this. Suggestions from contributors will be considered but not necessarily included in the release.

omalyshe · 2024-11-19T09:34:25Z

MAINTAINERS.md

+  * Commits to being responsible for that specific area.
+
+The process of becoming a Code Owner is:
+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file


Can a contributor nominate themselves?

I think it is acceptable.

aleksei-fedotov · 2024-11-19T10:07:05Z

MAINTAINERS.md

+| _Responsibilities_                                                                                                                          |                         |                         |                         |
+| Follow the Code of Conduct                                                                                                                  |            ✓            |            ✓           |            ✓            |
+| Follow Contribution Guidelines                                                                                                              |            ✓            |            ✓           |            ✓            |
+| Enforce Contribution Guidelines                                                                                                             |            ✗            |            ✓           |            ✓            |


Consider removing the ✗ signs to reduce cluttering.

Suggested change

| Enforce Contribution Guidelines | ✗ | ✓ | ✓ |

| Enforce Contribution Guidelines | | ✓ | ✓ |

I would prefer to keep it because it is aligned with https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role

MAINTAINERS.md

aleksei-fedotov · 2024-11-19T11:01:13Z

MAINTAINERS.md

+| Konstantin Boyarinov  | @kboyarinov           | Intel Corporation | Code Owner |
+| Aleksei Fedotov       | @aleksei-fedotov      | Intel Corporation | Code Owner |
+| Ilya Isaev            | @isaevil              | Intel Corporation | Code Owner |
+| Sarath Nandu R        | @sarathnandu          | Intel Corporation | Code Owner |
+| Dmitri Mokhov         | @dnmokhov             | Intel Corporation | Code Owner |
+| Michael Voss          | @vossmjp              | Intel Corporation | Maintainer |
+| Alexey Kukanov        | @akukanov             | Intel Corporation | Code Owner |
+| Pavel Kumbrasev       | @pavelkumbrasev       | Intel Corporation | Code Owner |


I suggest sorting the list by name as those are usually unique and does not depend on the account ID in case the project would move to another platform someday.

Also, what about e-mail addresses of people in the list? Do we want to list them here as well so that anyone interested can reach out to them in case of a need or we think that tagging a person in a GitHub Issue is enough?

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

timmiesmith · 2024-11-19T13:53:59Z

MAINTAINERS.md

+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file
+including name, Github username, and affiliation.
+2. At least two specific component Maintainers approve the PR.
+3. CODEOWNERS.md file is updated to represent corresponding areas of responsibility.


Should this be MAINTAINERS.md as well instead of a separate file where the areas are recorded?

Should this be MAINTAINERS.md as well instead of a separate file where the areas are recorded?

It is possible to use automatic reviewer assignment using CODEOWNERS file - https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#about-code-owners. We probably want to use it feature.

omalyshe · 2024-11-19T13:59:16Z

@pavelkumbrasev Check the codespell result

omalyshe · 2024-11-19T14:08:45Z

MAINTAINERS.md

+1. A Contributor is nominated by opening a PR modifying the MAINTAINERS.md file
+including name, Github username, and affiliation.
+2. At least two specific component Maintainers approve the PR.
+3. CODEOWNERS.md file is updated to represent corresponding areas of responsibility.


Should this be MAINTAINERS.md as well instead of a separate file where the areas are recorded?

It is possible to use automatic reviewer assignment using CODEOWNERS file - https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#about-code-owners. We probably want to use it feature.

MAINTAINERS.md

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

MAINTAINERS.md

aepanchi · 2024-11-20T15:57:37Z

MAINTAINERS.md

+ * [Maintainer](#maintainer)
+
+[permissions]: https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role
+


i would make 2 separate sections (responsibilities and roles) with the corresponding tables within

and: i would first put the contributor, code owner, and maintainer sections, and after it show the tables with differences

It is aligned with https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role
So I would prefer to keep it

MAINTAINERS.md

aepanchi · 2024-11-20T16:08:25Z

MAINTAINERS.md

+  * Demonstrated broad knowledge of the project across multiple areas.
+  * Commits to using privileges responsibly for the good of the project.
+  * Is able to exercise judgment for the good of the project, independent of
+    their employer, friends, or team.


how it can be measured though?

Perhaps, maintainer would need to present proofs.
I'm not sure how to measure this :)

MAINTAINERS.md

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

omalyshe

I think it is a good enough to get merged.

MAINTAINERS.md

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

pavelkumbrasev added 2 commits November 8, 2024 10:41

Initial commit

71a60d2

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Add table with responsibilities and privileges

1109f38

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

pavelkumbrasev requested review from aleksei-fedotov, vossmjp, omalyshe, timmiesmith, akukanov and aepanchi November 13, 2024 13:02

Fix aligment of the table and remove colors

7963ed6

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

isaevil reviewed Nov 14, 2024

View reviewed changes

MAINTAINERS.md Outdated Show resolved Hide resolved

Remove color

a715f1a

Co-authored-by: Ilya Isaev <ilya.isaev@intel.com>

omalyshe reviewed Nov 14, 2024

View reviewed changes

vossmjp reviewed Nov 19, 2024

View reviewed changes

pavelkumbrasev and others added 2 commits November 19, 2024 09:23

Apply suggestions from code review

ca4d538

Co-authored-by: Mike Voss <michaelj.voss@intel.com>

Update document

50993de

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

omalyshe reviewed Nov 19, 2024

View reviewed changes

aleksei-fedotov reviewed Nov 19, 2024

View reviewed changes

pavelkumbrasev and others added 2 commits November 19, 2024 12:32

Apply suggestions from code review

851ec85

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

Apply review comments

71fb5e4

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

timmiesmith reviewed Nov 19, 2024

View reviewed changes

omalyshe reviewed Nov 19, 2024

View reviewed changes

timmiesmith mentioned this pull request Nov 19, 2024

Defining developer roles, responsibilities, and privileges and leadership process oneapi-src/oneDPL#1940

Open

pavelkumbrasev added 3 commits November 19, 2024 14:19

Apply review comments

91285d6

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Apply review comments

25318ac

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Apply review comments

bb934c4

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

aepanchi reviewed Nov 20, 2024

View reviewed changes

Apply suggestions from code review

7f20b96

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>

pavelkumbrasev added 2 commits November 21, 2024 09:50

Apply review comments

2a51127

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Update the table

d1e49a1

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

omalyshe requested review from aepanchi, timmiesmith, vossmjp, isaevil, omalyshe and aleksei-fedotov November 22, 2024 11:54

omalyshe previously approved these changes Nov 22, 2024

View reviewed changes

aleksei-fedotov reviewed Nov 22, 2024

View reviewed changes

MAINTAINERS.md Outdated Show resolved Hide resolved

pavelkumbrasev dismissed omalyshe’s stale review via 45ccb8f November 22, 2024 14:23

Update MAINTAINERS.md

45ccb8f

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

This was referenced Nov 22, 2024

oneTBB Identified roles for contributors uxlfoundation/open-source-working-group#104

Open

oneTBB documented processes for leadership uxlfoundation/open-source-working-group#105

Open

	\| Enforce Contribution Guidelines \| ✗ \| ✓ \| ✓ \|
	\| Enforce Contribution Guidelines \| \| ✓ \| ✓ \|

		* [Maintainer](#maintainer)

		[permissions]: https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role

Introduce MAINTAINERS.md #1560

Are you sure you want to change the base?

Introduce MAINTAINERS.md #1560

Conversation

pavelkumbrasev commented Nov 13, 2024

Description

Other information

pavelkumbrasev commented Nov 13, 2024

Choose a reason for hiding this comment

isaevil Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omalyshe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omalyshe commented Nov 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omalyshe left a comment

Choose a reason for hiding this comment

isaevil Nov 14, 2024 •

edited

Loading