From 0d2ac654177fddc06d283e500f79c6336d762c76 Mon Sep 17 00:00:00 2001 From: Konstantin Pastbin Date: Sun, 22 Dec 2024 17:14:59 +0300 Subject: [PATCH 1/4] [docs] Move the Board details into a separate doc Signed-off-by: Konstantin Pastbin --- docs/{GOVERNANCE.md => GOVERNANCE/BOARD.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{GOVERNANCE.md => GOVERNANCE/BOARD.md} (100%) diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE/BOARD.md similarity index 100% rename from docs/GOVERNANCE.md rename to docs/GOVERNANCE/BOARD.md -- 2.45.3 From baecee0dc8b2ddc1f483b1d36b9371ae4c9b870c Mon Sep 17 00:00:00 2001 From: Konstantin Pastbin Date: Sun, 22 Dec 2024 22:50:25 +0300 Subject: [PATCH 2/4] [docs] Add Governance overview and Teams structure Signed-off-by: Konstantin Pastbin --- docs/GOVERNANCE.md | 20 +++++++++++++++++ docs/GOVERNANCE/TEAMS.md | 47 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 docs/GOVERNANCE.md create mode 100644 docs/GOVERNANCE/TEAMS.md diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md new file mode 100644 index 0000000000..07c009a9a2 --- /dev/null +++ b/docs/GOVERNANCE.md @@ -0,0 +1,20 @@ +# Governance + +The Organic Maps project is community-driven and has little hierarchy. + +## [The Board](GOVERNANCE/BOARD.md) +Ensures the project stays within its [Mission and Core Values](CORE_VALUES.md), +legally hosts project's assets like trademarks, domains, finances etc. and handles legal enquiries. +See [details](GOVERNANCE/BOARD.md) of Board's structure and responsibilities. + +## [Teams](GOVERNANCE/TEAMS.md) + +Day-to-day work and decisions are made by the teams of active contributors ("the doers") in their area of expertise, e.g. Android development, translations or devops, see [the full list of Teams](GOVERNANCE/TEAMS.md). + +At the moment there is no formal process to resolve non-technical disputes (e.g. UX disagreements or whether a proposed change fits into OM at all), +but there are some common sense guidelines / recommendations: + - strive to address all reasonable concerns + - ask more contributors and experts on the matter to provide their opinion + - refer to users' feedback, e.g. include the change into an alpha version or poll via communication channels + - usually an incremental improvement is better than no change at all, create separate issues for follow-up concerns + - give benefit of a doubt to the actual "doers" who commit their energy into code, designs, etc. diff --git a/docs/GOVERNANCE/TEAMS.md b/docs/GOVERNANCE/TEAMS.md new file mode 100644 index 0000000000..0b9126a19c --- /dev/null +++ b/docs/GOVERNANCE/TEAMS.md @@ -0,0 +1,47 @@ +# Teams + +A team is a group of people who work together on a specific area to further Organic Maps. +Team pages list responsibilities, active contributors ("doers") and permissions they hold, as well as links to team-specific docs and resources. + +Its not necessary to be a part of a team in order to submit a PR, take part in a discussion or otherwise participate in team's work. +People listed there are the most active contributors and "go to" persons, so that its clear whom to ask questions, request reviews, etc. +They could be trusted with extra permissions and accesses necessary for their work (e.g. merge rights). + +If you've been contributing actively then feel free to open a PR/issue to add yourself to relevant teams and/or request permissions needed to facilitate your work. + +- RELEASE +
stores accs, maps generation, alphas/betas + +- COMMS +
announcements (chats, social media, web site news), moderation + +- USER SUPPORT +
feedback in stores, emails, social media, managing issues, user-facing docs (FAQs) + +- TRANSLATIONS +
UI strings, store descriptions, rel notes, etc. + +- DESIGN +
UI, UX, graphic design, product design + +- GROWTH and SUSTAINABILITY +
marketing (SEO/ASO/SMM), user research, fundraising (donations, grants, monetization), attraction, retention and funding of contributors, financial transparency + +- EXPERTS +
subject matter experts and talent in different fields, willing to share their knowledge + +- ANDROID + +- IOS + +- MAPS +
map data, styles + +- APP CORE +
rendering, routing, search, editor, bookmarks & tracks, maps generator, desktop and mobile linux versions, etc. + +- DEVOPS +
servers / cdn, CI/CD, tooling + +- ADMINS +
manage individual and team permissions -- 2.45.3 From b689e84372c9091b69e202bd94624d33e3b91e33 Mon Sep 17 00:00:00 2001 From: Konstantin Pastbin Date: Sun, 22 Dec 2024 23:15:19 +0300 Subject: [PATCH 3/4] [docs] Add Android team page Signed-off-by: Konstantin Pastbin --- docs/GOVERNANCE/ANDROID_TEAM.md | 41 +++++++++++++++++++++++++++++++++ docs/GOVERNANCE/TEAMS.md | 2 +- 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 docs/GOVERNANCE/ANDROID_TEAM.md diff --git a/docs/GOVERNANCE/ANDROID_TEAM.md b/docs/GOVERNANCE/ANDROID_TEAM.md new file mode 100644 index 0000000000..eaa64cc8f7 --- /dev/null +++ b/docs/GOVERNANCE/ANDROID_TEAM.md @@ -0,0 +1,41 @@ +# Android team + +- Android app development +- Feature implementation +- Testing and debugging +- Performance optimization +- Code review + +Together with the [iOS team](IOS_TEAM.md) strive for feature parity and UI/UX consistency across platforms. + +For UI/UX help ask the [Design team](DESIGN_TEAM.md). + +### Active contributors and their permissions +- @rtsysik (merger) +- @vng (merger) +- @biodranik (merger) +- @pastk (merger) +- @kirylkaveryn (merger) +- @redauburn (repo write) +- @kavikhalique +- @dvdmrtnz +- @andrewshkrob (repo write) +- @strump (repo write) +- @map-per + +Android Auto developers and testers: @organicmaps/android-auto. + +Ask for technical reviews from @organicmaps/android (also see CODEOWNERS). +At least one technical approval is required for a merge. + +Quality assurance: +PR authors are expected to test their changes extensively and reviewers to help with it. +But we'd love to have some people commited to testing specifically! Add yourself here! + +You don't have to be listed above to submit a PR occasionally, take part in a discussion or do a review. + +If you've been contributing actively for some time then feel free to open a PR to be added into the contributors list. +Likewise open a PR/issue to ask for permissions like write access, merge rights or if you want to be added into the technical reviewers: + +### Docs and resources +- [Java Style Guide](JAVA_STYLE.md) diff --git a/docs/GOVERNANCE/TEAMS.md b/docs/GOVERNANCE/TEAMS.md index 0b9126a19c..e6c84f476e 100644 --- a/docs/GOVERNANCE/TEAMS.md +++ b/docs/GOVERNANCE/TEAMS.md @@ -30,7 +30,7 @@ If you've been contributing actively then feel free to open a PR/issue to add yo - EXPERTS
subject matter experts and talent in different fields, willing to share their knowledge -- ANDROID +- [ANDROID](ANDROID_TEAM.md) - IOS -- 2.45.3 From 24a3a4c370140e1e06a5a4772106f68ad4a76213 Mon Sep 17 00:00:00 2001 From: Konstantin Pastbin Date: Mon, 23 Dec 2024 22:58:38 +0300 Subject: [PATCH 4/4] [docs] Add EXPERTS umbrella team Signed-off-by: Konstantin Pastbin --- docs/GOVERNANCE/EXPERTS_TEAM.md | 17 +++++++++++++++++ docs/GOVERNANCE/TEAMS.md | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/GOVERNANCE/EXPERTS_TEAM.md diff --git a/docs/GOVERNANCE/EXPERTS_TEAM.md b/docs/GOVERNANCE/EXPERTS_TEAM.md new file mode 100644 index 0000000000..b201eba0d5 --- /dev/null +++ b/docs/GOVERNANCE/EXPERTS_TEAM.md @@ -0,0 +1,17 @@ +# Experts and talent + +An umbrella "team" for pools of subject matter experts and talent in various fields. + +If you need an expert advice in a specific matter like OpenGL, then just tag/mention a relevant group and ask for help. +If you're an expert in a certain matter and is willing to help the project by sharing your knowledge occasionally then sign up please! + +Tag one of these if you seek help/advice on specific matters: +- @organicmaps/cpp - C++ experts and learners +- @organicmaps/privacy - privacy best practicies +- @organicmaps/shaders - 3D graphics and shaders experts +- @organicmaps/web - web development +- @organicmaps/brainstorm - general brainstorming of raw ideas +- @organicmaps/legal - legal matters, licenses compliance +- @organicmaps/community - community relations, insights into users' feedback and preferences + +Please open an issue/PR to ask to be added into one of the pools above or to create a new one! diff --git a/docs/GOVERNANCE/TEAMS.md b/docs/GOVERNANCE/TEAMS.md index e6c84f476e..4edb370320 100644 --- a/docs/GOVERNANCE/TEAMS.md +++ b/docs/GOVERNANCE/TEAMS.md @@ -27,7 +27,7 @@ If you've been contributing actively then feel free to open a PR/issue to add yo - GROWTH and SUSTAINABILITY
marketing (SEO/ASO/SMM), user research, fundraising (donations, grants, monetization), attraction, retention and funding of contributors, financial transparency -- EXPERTS +- [EXPERTS](EXPERTS_TEAM.md)
subject matter experts and talent in different fields, willing to share their knowledge - [ANDROID](ANDROID_TEAM.md) -- 2.45.3