thecomputekid / tribo Goto Github PK

This file should be ignored by Git.

Add static analysis check config.

Stale workflows should be stopped for the "main", not "master" branch.

Public forks require the pull_request tag in the workflow config.

Add convenience for building CMake presets.

Clean up the root repo directory.

Code coverage should be added to the testing framework, though it would be good if it could somehow be incorporated into CMake for elegance. This could be tricky as code coverage requires all tests to run, so there is a dependency.

Add an initial set of clang-format rules.

The windows clang build does not actually use clang. This was probably mistakenly removed.

A minimum version of 3.10 is needed to build the "tools".

Ensures a recent version of clang is used during workflows.

A minimal project readme should be added, with the project name and tagline.

Cross-compiler compatibility should be ensured in GitHub actions:

• On Linux, clang-17 and gcc-13 should be used.
• On MacOS, clang-17 should be used.
• On Windows, MSVC (cl) and clang-17 should be used.

A skeleton project to get compilation started.

Add a minimal cmake config file.

Integrate and enforce doxygen as part of the build.

A reasonable open-source license (preferably an MIT license) should be added before project work is started.

Add CODEOWNERS to help with code-reviews.

A convenience script should be added so that pipelines (or users) can run it to build the complete project.

This helps if the system does not have the latest ninja. Also useful for ci/cd. Assume an old version of CMake is present on the system.

Build scripts are not needed when CMakePresets are used.

Ci/Cd pipelines must be added before code can be submitted.

It is a waste of resources to continue a workflow when a pull request is updated. An automated method to cancel running jobs should be added.

Aesthetic changes for visual pleasure.

Using an action will allow faster builds, as they are cached. This would also require a change to the way ci is done, and hence the documentation will change.

CMake 3.28 may not be available on every system, so a script to build it should be added. This will also be useful later for ci/cd builds.

Users should be able to read the doc and build tools if needed.

CMakePresets.json should have all the required compiler combinations, instead of doing it via the ci pipelines.