[Story] - Organization, Rules, Tools & Toolchain

[ladislas]

Introduction

LekaOS is a great project and a big project that will grow in size considerably over the next few months. It's important for the sanity of all the developers involved that good defaults and standards are setup and chosen at the beginning to reduce friction and bikeshedding.

Different topics will be covered:

• folder organization
• naming conventions
• coding style
• testing
• CI & automation
• toolchains

Folder/Directory organization

LekaOS will follow the monorepo philosophy, which means that all the dependencies will be located inside this repository. No external dependencies, no submodules, everything must compile after git clone.

⚠️ One exception might be large binary files (e.g. images, sounds, etc.). Extra care must be taken and each case must be discussed.

Root folders will be:

• .azure-ci or .github - CI related tasks
• docs - documentation
• lib - library folder
• src - sources of the main application
• test - tests --> unit, functional, integration
• script - scripts used by different processes

Naming conventions

⚠️ to do

Coding style

Coding style is taken care of by EditorConfig and ClangFormat.

Testing

⚠️ to do

CI & Automation

⚠️ in progress

• use https://github.com/codespell-project/codespell to check for spelling errors in code
• use clang-format-lint to check style - https://github.com/marketplace/actions/clang-format-lint

Toolchains

LekaOS will be compiled using GCC ARM None Eabi.

Some tests must be run to see wether we use mbed-cli, Make of CMake.