From 44dbcfa59ec9d575475faa8c20d6806aaf71e4e8 Mon Sep 17 00:00:00 2001 From: Tobias Date: Fri, 24 May 2024 07:04:30 +0200 Subject: [PATCH 01/10] First draft of adding a role and people documentation --- MAINTANANCE.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 MAINTANANCE.md diff --git a/MAINTANANCE.md b/MAINTANANCE.md new file mode 100644 index 000000000..0d2ce8b16 --- /dev/null +++ b/MAINTANANCE.md @@ -0,0 +1,68 @@ + +INSPIRED BY https://github.com/streetcomplete/StreetComplete/blob/master/AUTHORS.md + + +# Roles, people and processes on maintaining the tagging schema + +This document outlines how this project is maintained. + +## Roles & People + +### Maintainer role + +[Martin](https://github.com/tyrasd) maintains this project as part of his work on the iD Editor project. + +The maintainer role includes… +- a final say in decision for the tagging schema +- creating releases +- updating dependencies + +and all following roles. + +### Contributor role + +[Tobias](https://github.com/tordans) contributes to this project as a volunteer. + +The contributor role inclues… +- reviewing PRs +- merging "simple" PRs + +and all following roles. + +### Triage role + +(No one has the triage role ATM. Please reach out if you want to help.) + +The triage role inclues… +- helping to clarify issues and PRs +- closing issues as duplicate or not planned + +### Contributors + +To all contributors, thank you so much for your support! ❤ +Especially for… +- Suggesting new presets and fields or updates to the repo +- Researching and helping with issues and PRs +- Translating the tagging schema + +Code contributions: [Check this complete list of contributors on GitHub](https://github.com/openstreetmap/id-tagging-schema/graphs/contributors) + +## Processes + +### PR reviews, PR merge + +- PR need two sets of yes, the authors and another contributor role before being merged +- Non-"simple" changes need to be merged by the maintainer role +- We might revert merges later + +### Releases + +There is no release shedule at the moment but usually happen every other month. +After this project was released the projects that rely on the data need to update and release as well. + +## Previous maintainers + +Many thanks to all previous maintainers! ❤ + +- [Quincy](https://github.com/quincylvania) +- [Bryan](https://github.com/bhousel) From 15617bde0a041895ec626efaa410f01074c6c179 Mon Sep 17 00:00:00 2001 From: Tobias Date: Fri, 24 May 2024 07:18:16 +0200 Subject: [PATCH 02/10] Ask ChatGPT to improve the english language --- MAINTANANCE.md | 62 +++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 34 deletions(-) diff --git a/MAINTANANCE.md b/MAINTANANCE.md index 0d2ce8b16..f27bc68a7 100644 --- a/MAINTANANCE.md +++ b/MAINTANANCE.md @@ -1,66 +1,60 @@ - -INSPIRED BY https://github.com/streetcomplete/StreetComplete/blob/master/AUTHORS.md - - -# Roles, people and processes on maintaining the tagging schema +# Roles, People, and Processes for Maintaining the Tagging Schema This document outlines how this project is maintained. ## Roles & People -### Maintainer role +### Maintainer Role [Martin](https://github.com/tyrasd) maintains this project as part of his work on the iD Editor project. -The maintainer role includes… -- a final say in decision for the tagging schema -- creating releases -- updating dependencies +The maintainer role includes: +- Having the final say in decisions for the tagging schema. +- Creating releases. +- Updating dependencies. -and all following roles. +and all the following roles. -### Contributor role +### Contributor Role [Tobias](https://github.com/tordans) contributes to this project as a volunteer. -The contributor role inclues… -- reviewing PRs -- merging "simple" PRs +The contributor role includes: +- Reviewing PRs. +- Merging "simple" PRs. -and all following roles. +and all the following roles. -### Triage role +### Triage Role -(No one has the triage role ATM. Please reach out if you want to help.) +(No one has the triage role at the moment. Please reach out if you want to help.) -The triage role inclues… -- helping to clarify issues and PRs -- closing issues as duplicate or not planned +The triage role includes: +- Helping to clarify issues and PRs. +- Closing issues as duplicates or not planned. ### Contributors -To all contributors, thank you so much for your support! ❤ -Especially for… -- Suggesting new presets and fields or updates to the repo -- Researching and helping with issues and PRs -- Translating the tagging schema +To all contributors, thank you so much for your support! ❤ Especially for: +- Suggesting new presets and fields or updates to the repository. +- Researching and helping with issues and PRs. +- Translating the tagging schema. -Code contributions: [Check this complete list of contributors on GitHub](https://github.com/openstreetmap/id-tagging-schema/graphs/contributors) +Code contributions: [Check this complete list of contributors on GitHub](https://github.com/openstreetmap/id-tagging-schema/graphs/contributors). ## Processes -### PR reviews, PR merge +### PR Reviews and Merges -- PR need two sets of yes, the authors and another contributor role before being merged -- Non-"simple" changes need to be merged by the maintainer role -- We might revert merges later +- PRs need approval from two people: the author and another contributor before being merged. +- Non-"simple" changes need to be merged by the maintainer. +- We might revert merges later if necessary. ### Releases -There is no release shedule at the moment but usually happen every other month. -After this project was released the projects that rely on the data need to update and release as well. +There is no set release schedule at the moment, but releases usually occur every other month. After this project is released, the projects that rely on the data need to update and release as well. -## Previous maintainers +## Previous Maintainers Many thanks to all previous maintainers! ❤ From db89cf30f4e5dc6d623b6aa56ff7d0056b18bc12 Mon Sep 17 00:00:00 2001 From: Tobias Date: Fri, 31 May 2024 10:36:36 +0200 Subject: [PATCH 03/10] Maintenance: Clarify guidelines, add Kyle --- MAINTANANCE.md => MAINTENANCE.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) rename MAINTANANCE.md => MAINTENANCE.md (74%) diff --git a/MAINTANANCE.md b/MAINTENANCE.md similarity index 74% rename from MAINTANANCE.md rename to MAINTENANCE.md index f27bc68a7..93499cfbb 100644 --- a/MAINTANANCE.md +++ b/MAINTENANCE.md @@ -17,11 +17,12 @@ and all the following roles. ### Contributor Role -[Tobias](https://github.com/tordans) contributes to this project as a volunteer. +- [Kyle](https://github.com/k-yle) contributes to this project as a volunteer. +- [Tobias](https://github.com/tordans) contributes to this project as a volunteer. The contributor role includes: - Reviewing PRs. -- Merging "simple" PRs. +- Merging "clear-cut" PRs. and all the following roles. @@ -46,10 +47,15 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ ### PR Reviews and Merges -- PRs need approval from two people: the author and another contributor before being merged. -- Non-"simple" changes need to be merged by the maintainer. +- PRs need approval from two people: the author and one more contributors before being merged. +- Non-"clear-cut" changes need to be merged by the maintainer. - We might revert merges later if necessary. +**What is a clear-cut change?** + +- No or minimal controversial discussion on the change. +- Coding and contribution [guidelines](./GUIDELINES.md) are met. + ### Releases There is no set release schedule at the moment, but releases usually occur every other month. After this project is released, the projects that rely on the data need to update and release as well. @@ -58,5 +64,6 @@ There is no set release schedule at the moment, but releases usually occur every Many thanks to all previous maintainers! ❤ +- [Milos](https://github.com/mbrzakovic) - [Quincy](https://github.com/quincylvania) - [Bryan](https://github.com/bhousel) From 6cf79d5a491f7d985d9af2970e9db21f95b31eb2 Mon Sep 17 00:00:00 2001 From: Tobias Date: Fri, 31 May 2024 10:49:26 +0200 Subject: [PATCH 04/10] Maintenance: Describe how to merge --- MAINTENANCE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 93499cfbb..fd3117684 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -56,6 +56,12 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ - No or minimal controversial discussion on the change. - Coding and contribution [guidelines](./GUIDELINES.md) are met. +**How to merge…** + +- Usually sqash merge PRs to make the history simpler +- Give the Merge a meaningfull description of the change +- Add labels to the PR to simplify creating the changelog: `new-*`, `add-*`, `bug` + ### Releases There is no set release schedule at the moment, but releases usually occur every other month. After this project is released, the projects that rely on the data need to update and release as well. From 30c477477324049b05d4588e951a716f32f5bb9d Mon Sep 17 00:00:00 2001 From: Tobias Date: Wed, 5 Jun 2024 19:33:33 +0200 Subject: [PATCH 05/10] Improve wording Co-authored-by: Mateusz Konieczny --- MAINTENANCE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index fd3117684..860deb6f5 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -47,7 +47,7 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ ### PR Reviews and Merges -- PRs need approval from two people: the author and one more contributors before being merged. +- PRs need approval from two people: the author and one or more contributors before being merged. - Non-"clear-cut" changes need to be merged by the maintainer. - We might revert merges later if necessary. @@ -59,7 +59,7 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ **How to merge…** - Usually sqash merge PRs to make the history simpler -- Give the Merge a meaningfull description of the change +- Give the merge a meaningful description of the change - Add labels to the PR to simplify creating the changelog: `new-*`, `add-*`, `bug` ### Releases From 50f0ff76cff4cb4def845ca1bb96c01da6c790a5 Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Wed, 5 Jun 2024 19:38:43 +0200 Subject: [PATCH 06/10] fix typo --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 860deb6f5..b2b5a3bd8 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -58,7 +58,7 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ **How to merge…** -- Usually sqash merge PRs to make the history simpler +- Usually squash merge PRs to make the history simpler - Give the merge a meaningful description of the change - Add labels to the PR to simplify creating the changelog: `new-*`, `add-*`, `bug` From 80cb9e807d7323f5d87abe08ace0b5096e34cbf6 Mon Sep 17 00:00:00 2001 From: Tobias Date: Wed, 5 Jun 2024 20:06:23 +0200 Subject: [PATCH 07/10] Docs: Add section on assigning roles --- MAINTENANCE.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index b2b5a3bd8..80c4dc020 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -66,6 +66,11 @@ Code contributions: [Check this complete list of contributors on GitHub](https:/ There is no set release schedule at the moment, but releases usually occur every other month. After this project is released, the projects that rely on the data need to update and release as well. +### Assigning roles + +- The maintenance role is assigned by the OSMF. Historically the maintainer of the iD Editor also maintained this project. +- Contributor and triage roles are assigned by the current maintainer of the repository. + ## Previous Maintainers Many thanks to all previous maintainers! ❤ From 81464b6dc0cecdc0cba4d4c003b0db84490e7bb2 Mon Sep 17 00:00:00 2001 From: Tobias Date: Thu, 6 Jun 2024 06:30:56 +0200 Subject: [PATCH 08/10] Docs: Add "assign roles" to maintainer role https://github.com/openstreetmap/id-tagging-schema/pull/1230/files#r1628740958 --- MAINTENANCE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 80c4dc020..45be11cfb 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -12,6 +12,7 @@ The maintainer role includes: - Having the final say in decisions for the tagging schema. - Creating releases. - Updating dependencies. +- Assign roles. and all the following roles. From 817a6422c9278bc27baf42439b0ea1486dd52040 Mon Sep 17 00:00:00 2001 From: Tobias Date: Thu, 6 Jun 2024 06:51:07 +0200 Subject: [PATCH 09/10] Docs: Update assign roles section --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 45be11cfb..e00205c05 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -69,7 +69,7 @@ There is no set release schedule at the moment, but releases usually occur every ### Assigning roles -- The maintenance role is assigned by the OSMF. Historically the maintainer of the iD Editor also maintained this project. +- The maintainer of the iD editor has traditionally and continues to maintain this project. - Contributor and triage roles are assigned by the current maintainer of the repository. ## Previous Maintainers From 4e1a2253bad17c9a4656d0b221b1d77d0980d185 Mon Sep 17 00:00:00 2001 From: Tobias Date: Thu, 6 Jun 2024 06:58:35 +0200 Subject: [PATCH 10/10] Docs: Add github labels --- MAINTENANCE.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index e00205c05..f3ee8ed8f 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -16,6 +16,8 @@ The maintainer role includes: and all the following roles. +Github shows a `(Member)` label next to users with full access to this repository and the organisation. + ### Contributor Role - [Kyle](https://github.com/k-yle) contributes to this project as a volunteer. @@ -27,6 +29,8 @@ The contributor role includes: and all the following roles. +Github shows a `(Collaborator)` label next to users with any permission on this repository. + ### Triage Role (No one has the triage role at the moment. Please reach out if you want to help.) @@ -35,6 +39,8 @@ The triage role includes: - Helping to clarify issues and PRs. - Closing issues as duplicates or not planned. +Github shows a `(Collaborator)` label next to users with any permission on this repository. + ### Contributors To all contributors, thank you so much for your support! ❤ Especially for: @@ -44,6 +50,8 @@ To all contributors, thank you so much for your support! ❤ Especially for: Code contributions: [Check this complete list of contributors on GitHub](https://github.com/openstreetmap/id-tagging-schema/graphs/contributors). +Github shows a `(Contributor)` label next to users that previously committed to this repository. + ## Processes ### PR Reviews and Merges