From 3b201f115ee99e83b13ae3a4a17b039b32fdb59a Mon Sep 17 00:00:00 2001 From: Leslie Hawthorn Date: Wed, 12 Jun 2024 12:45:39 +0200 Subject: [PATCH 1/3] update read me with examples of trivial/non-trivial changes And clarify when action must be taken by an oversight committee member. This PR is meant to address issue 91. https://github.com/instructlab/dev-docs/issues/91 Signed-off-by: Leslie Hawthorn --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8f4da43f..1e852573 100644 --- a/README.md +++ b/README.md @@ -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, 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 From 0b926c1b439f79a1072761bf133acc9d8fee82d7 Mon Sep 17 00:00:00 2001 From: Martin Hickey Date: Thu, 4 Jul 2024 10:53:48 +0100 Subject: [PATCH 2/3] Update README.md Co-authored-by: Russell Bryant Signed-off-by: Martin Hickey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e852573..ec9e0efa 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ 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. + 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 From 4fd0bb40db7dab3d576f411097cbe79ad078e421 Mon Sep 17 00:00:00 2001 From: Martin Hickey Date: Thu, 4 Jul 2024 10:53:55 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: Russell Bryant Signed-off-by: Martin Hickey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec9e0efa..936a9712 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ please ping the Oversight Committee for help. 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, etc. + 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