From 9a2b3083d89e3c78bc9962af73ac865a558c222b Mon Sep 17 00:00:00 2001 From: Leonardo Date: Fri, 21 Aug 2026 15:14:31 -0400 Subject: [PATCH 01/10] docs: Initial CONTRIBUTING.md file An initial pass at developing procedures and policies for contributing developers. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4f1a62613 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing to Obtanium! + +Basic procedures on how to contribute to Obtanium. + +## Translations / i18n + +User shown text strings are located in `.json` files in `assets/translations/`. +The main template file is `en.json`. At a minimum please add english translations for any new strings to this file. + +`assets/translations/standardize.mjs` and MTL may be used as a first pass to add translations for other languages. From 64bc81f0c05a9e2aa9a3d897bbad00d2ff033fcc Mon Sep 17 00:00:00 2001 From: Leonardo Date: Fri, 21 Aug 2026 15:22:50 -0400 Subject: [PATCH 02/10] docs: CONTRIBUTING.md - Improve linking --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f1a62613..42432230d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Basic procedures on how to contribute to Obtanium. ## Translations / i18n -User shown text strings are located in `.json` files in `assets/translations/`. -The main template file is `en.json`. At a minimum please add english translations for any new strings to this file. +User shown text strings are located in `*.json` files in assets/translations/. +The main template file is [en.json](assets/translations/en.json). At a minimum please add english translations for any new strings to this file. -`assets/translations/standardize.mjs` and MTL may be used as a first pass to add translations for other languages. +[standardize.mjs](assets/translations/standardize.mjs) and MTL may be used as a first pass to add translations for other languages, until more apt translations are proposed. From 911eaf0d7a0f1a73b3dfc69777f90a5ef29b3845 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Fri, 21 Aug 2026 15:25:14 -0400 Subject: [PATCH 03/10] docs: CONTRIBUTING.md - i18n, folder link added --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42432230d..dbeb8906c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Basic procedures on how to contribute to Obtanium. ## Translations / i18n -User shown text strings are located in `*.json` files in assets/translations/. +User shown text strings are located in `*.json` files in [assets/translations/](assets/translations). The main template file is [en.json](assets/translations/en.json). At a minimum please add english translations for any new strings to this file. [standardize.mjs](assets/translations/standardize.mjs) and MTL may be used as a first pass to add translations for other languages, until more apt translations are proposed. From 06855488e1e84bd9ed42c14d796634ee5d3f7ae5 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Fri, 21 Aug 2026 15:26:46 -0400 Subject: [PATCH 04/10] docs: CONTRIBUTING.md -i18n - minor --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbeb8906c..aece21065 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Basic procedures on how to contribute to Obtanium. ## Translations / i18n -User shown text strings are located in `*.json` files in [assets/translations/](assets/translations). +User shown text strings are located in `*.json` files in [assets/translations](assets/translations). The main template file is [en.json](assets/translations/en.json). At a minimum please add english translations for any new strings to this file. [standardize.mjs](assets/translations/standardize.mjs) and MTL may be used as a first pass to add translations for other languages, until more apt translations are proposed. From 13bdc7617dfac5852428d1f89e18140313d61e3e Mon Sep 17 00:00:00 2001 From: Leonardo Date: Sat, 22 Aug 2026 12:19:44 -0400 Subject: [PATCH 05/10] docs: CONTRIBUTING.md -> Init Style Initially added style section. Spacing & bracing. --- CONTRIBUTING.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aece21065..4b8706fe0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,25 @@ # Contributing to Obtanium! -Basic procedures on how to contribute to Obtanium. +Policies and procedures on contributing to Obtanium. + +## Style + +### Bracing + +Please use the "K&R" bracing style. + +```Kotlin +override fun onCreate(savedInstanceState: Bundle?) { + intent?.let { + setIntent(transformShareIntent(it)) + } + super.onCreate(savedInstanceState) +} +``` + +### Indentation + +Obtanium is a mixed spacing project; tabs are **not** used. Files will use either four or two spaces as indentation. Please follow the spacing in the current file. New files should use 4 spaces. ## Translations / i18n From 973cf4c1d0345da1cd689f09974d758b185f4b20 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Sat, 22 Aug 2026 13:52:17 -0400 Subject: [PATCH 06/10] docs: CONTRIBUTING.md -> Added different users Added different sections for various users, general and developers. General includes those who will write bug reports. Also those who are translators. --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b8706fe0..d445403ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,15 @@ Policies and procedures on contributing to Obtanium. -## Style +## Bug Reports -### Bracing +Welcomed! + +## Development + +### Style + +#### Bracing Please use the "K&R" bracing style. @@ -17,7 +23,7 @@ override fun onCreate(savedInstanceState: Bundle?) { } ``` -### Indentation +#### Indentation Obtanium is a mixed spacing project; tabs are **not** used. Files will use either four or two spaces as indentation. Please follow the spacing in the current file. New files should use 4 spaces. @@ -27,3 +33,5 @@ User shown text strings are located in `*.json` files in [assets/translations](a The main template file is [en.json](assets/translations/en.json). At a minimum please add english translations for any new strings to this file. [standardize.mjs](assets/translations/standardize.mjs) and MTL may be used as a first pass to add translations for other languages, until more apt translations are proposed. + +Please also follow the [indentation style](#### Indentation). From 5f17f37e1e53ac799dd86787e16e5fd6d30d16a1 Mon Sep 17 00:00:00 2001 From: Leonardo Canessa Date: Sat, 22 Aug 2026 13:58:29 -0400 Subject: [PATCH 07/10] docs: CONTRIBUTING (minor) fixup internal link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d445403ac..9d52d498f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,4 +34,4 @@ The main template file is [en.json](assets/translations/en.json). At a minimum p [standardize.mjs](assets/translations/standardize.mjs) and MTL may be used as a first pass to add translations for other languages, until more apt translations are proposed. -Please also follow the [indentation style](#### Indentation). +Please also follow the [indentation style](#indentation). From 6971682015cdf491b9a560284f72e5d76457c934 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Mon, 24 Aug 2026 12:47:08 -0400 Subject: [PATCH 08/10] docs:CONTRIBUTING.md->Add logging section for devs Add a section about using internal logging class and examples. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d52d498f..7d9cdc62a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,12 @@ Welcomed! ## Development +### Logging + +Please use our [AppLogger](lib/core/logging/app_logger.dart) for any internal logging. + +There are plenty of examples of it's use in [main.dart](lib/main.dart). + ### Style #### Bracing From ebd5fc2bb719c4512719a1329fe5570b2e764d9e Mon Sep 17 00:00:00 2001 From: Leonardo Date: Mon, 24 Aug 2026 12:58:02 -0400 Subject: [PATCH 09/10] docs: CONTRIBUTING.md Improved Bug Report section Added a link to a good article on writing good bug reports. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d9cdc62a..390139adf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,8 @@ Policies and procedures on contributing to Obtanium. Welcomed! +If you want to be excellent, please consider implementing this guide, [The Art Of The Bug Report](https://www.ministryoftesting.com/insights/11b82aee). + ## Development ### Logging From bd08fbdedb615356835ef53c821e940ccb825112 Mon Sep 17 00:00:00 2001 From: Leonardo Date: Mon, 24 Aug 2026 13:05:54 -0400 Subject: [PATCH 10/10] docs:CONTRIBUTING.md->Bug reports (minor). --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 390139adf..a6313f2e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Policies and procedures on contributing to Obtanium. Welcomed! -If you want to be excellent, please consider implementing this guide, [The Art Of The Bug Report](https://www.ministryoftesting.com/insights/11b82aee). +If you want to be excellent, please consider implementing this guide, [The Art Of The Bug Report](https://www.ministryoftesting.com/insights/11b82aee), when writing bug reports. ## Development