Skip to content

Commit

Permalink
Update Contributor Roles documentation
Browse files Browse the repository at this point in the history
The Oversight Committee now exists, so updated the doc to reflect as such
Noted this doc serves as the contributor roles for all repos if no repo-specifc doc exists
Removed options for Maintainer Nominees to sponsor themselves
Removed email requirement in favor of new nomination GitHub Issue template
Change private Maintainer voting to public

Co-authored-by: Russell Bryant <rbryant@redhat.com>
Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
  • Loading branch information
nathan-weinberg and russellb committed May 30, 2024
1 parent 2ac7957 commit c303638
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
1 change: 1 addition & 0 deletions .spellcheck-en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ aldopareja
alimaredia
Alina
alinaryan
amongst
Anh
anik
Anza
Expand Down
13 changes: 6 additions & 7 deletions CONTRIBUTOR_ROLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ InstructLab is made up of several projects that are defined as codebases and ser
* [`ilab` command-line interface (CLI) tool](https://github.com/instructlab/instructlab). This repository is responsible for the the `ilab` CLI tool.
* [taxonomy tree](https://github.com/instructlab/taxonomy). This repository is responsible for the taxonomy tree that allows you to create models tuned with your data.

This document outlines a core number of contributor roles for InstructLab projects, such as _Member_, _Triager_, and _Maintainer_. An _Oversight Committee_ also serves to supervise the overall InstructLab project and its health. Using transparent criteria, the journey between roles is based on individual participation.
This document outlines a core number of contributor roles for InstructLab projects, such as _Member_, _Triager_, and _Maintainer_. An _Oversight Committee_ also exists to supervise the overall InstructLab project and its health. Using transparent criteria, the journey between roles is based on individual participation.

Criteria will be reevaluated periodically to ensure that we can meet the needs of each project with the resources available to contribute. Each individual project may add to or change these criteria as necessary. Additional roles may also be added as required. Additional roles will be detailed in a _Contributor Roles_ file in the respective repository when necessary.
Criteria will be reevaluated periodically to ensure that we can meet the needs of each project with the resources available to contribute. Each individual project may add to or change these criteria as necessary. Additional roles may also be added as required. Additional roles will be detailed in a _Contributor Roles_ file in the respective repository when necessary. If no _Contributor Roles_ file exists in a repository, it is assumed to follow the scheme outlined here.

Contributor roles are per-project. For example, being a Maintainer for the `ilab` CLI repository does not guarantee that you will have Maintainer rights for the taxonomy repository. Where applicable for InstructLab overall, contributor status is equal to the highest status that they have on any project.

Expand Down Expand Up @@ -56,6 +56,8 @@ As a project Member, you have the following responsibilities and privileges:
* You provide code that consistently pass tests.
* You consistently address bugs or issues that are discovered after code has been accepted.

[!NOTE] Members who frequently contribute code are expected to proactively perform code reviews and work towards becoming a Reviewer for the project that they are active in.

### Triager

Triagers are active contributors in the community through issue and pull request triage. Triagers are expected to remain active in this task.
Expand Down Expand Up @@ -107,12 +109,9 @@ To become a project Maintainer, you must meet the following requirements:
* You have directly contributed to the project through implementation and/or review.
* You have been sponsored by two Maintainers.

If you meet the requirements, nominate yourself to become a Maintainer by sending an email to the Maintainers with your candidacy. You must:

* Ensure that your sponsors are `@mentioned` on the email.
* Include a list of contributions representative of your work on the project.
One of the sponsors should open an issue in the relevant repository to provide a nomination. The issue should use the provided nomination template if one exists in that repo. If one does not exist, the sponsor should create a template prior to creating the nomination.

Maintainers will vote privately and respond to the issue with either acceptance or with feedback for suggested improvement. Feedback may be given privately.
Maintainers will vote publicly on the issue, expressing their support via a GitHub comment or emoji reaction to the nomination summary. Any concerns may be discussed privately amongst the existing Maintainer team. If feedback needs to be given to the nominee, the sponsor should provide that feedback privately.

After a [decision has been made](https://github.com/instructlab/community/blob/main/governance.md#decision-making-at-the-instructlab-org-level), a Maintainer will create a PR to add you in the [MAINTAINER file](https://github.com/instructlab/community/blob/main/MAINTAINERS.md) within three weeks.

Expand Down

0 comments on commit c303638

Please sign in to comment.