Skip to content

Commit

Permalink
Merge pull request #92 from instructlab/lhawthorn-patch-3
Browse files Browse the repository at this point in the history
update read me with examples of trivial/non-trivial changes
  • Loading branch information
russellb authored Jul 5, 2024
2 parents 1a65993 + 4fd0bb4 commit 88f2461
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,22 @@ The [InstructLab Oversight
Committee](https://github.com/instructlab/community/blob/main/MAINTAINERS.md) is
responsible for the contents of this repository.

The rules for merging depend on the type of change in question and its scope of impact.
The rules for merging depend on the type of change in question and its scope of impact. If you
are unsure about the scope of impact for a change, i.e. if a change is trivial or non-trivial,
please ping the Oversight Committee for help.

* Trivial changes may be merged with 1 review from any InstructLab maintainer.
* Examples of trivial changes include minor wording adjustments or typo fixes in
documentation, changes to CI fixes, CI dependency updates, etc.
* Non-trivial changes have more loosely defined requirements. Input should be sought
out from maintainers of relevant components. The broader the scope or more
controversial the change, the more broad the consensus should be required for
merging. The final approval and merge falls to a member of the Oversight Committee.
This final review is to ensure that adequate opportunity and attention has
been given by the affected parties.
merging. The final approval and merge (or action, e.g. deleting a repo)
falls to a member of the Oversight Committee. This final review is to ensure that
adequate opportunity and attention has been given by the affected parties.
* Examples of non-trivial changes include approving proposal for new repositories,
creation of new repositories, changes to organization level GitHub settings, archiving
or deleting repositories, design proposals, etc.
* Any maintainer or oversight committee member may request that a change receive
a full vote from the Oversight Committee. More substantial policy changes or a
proposed new project under InstructLab are examples of when this may be
Expand Down

0 comments on commit 88f2461

Please sign in to comment.