Policies and procedures on contributing to Obtanium.
AI use is acceptable, only if you are able to audit the code. This means that you must understand the code that is generated. Please ensure that any AI generated code is also sufficiently tested.
Welcomed!
If you want to be excellent, please consider implementing this guide, The Art Of The Bug Report, when writing bug reports.
And for any testers out there How to think like a Tester is a good introduction.
Please see the developer guide for in-depth details about Obtanium's architecture. Please also update this when making relevant changes.
It is encouraged that all commits have their signature verified, that is signed. Please see the relevant GitHub documentation; this links to SSH key signing, but other signing is acceptable.
Please use our AppLogger for any internal logging.
There are plenty of examples of it's use in main.dart.
Please use the "K&R" bracing style.
override fun onCreate(savedInstanceState: Bundle?) {
intent?.let {
setIntent(transformShareIntent(it))
}
super.onCreate(savedInstanceState)
}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.
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.
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.