I’ve recently been selected for Season of KDE (SoK) and need to create a repository for my project.
Initially, I’ll create it on my personal profile, but it will later be transferred to the official KDE repository.
I’m wondering if there’s an official KDE repository structure that I should follow when setting up my project. Any guidance on this would be greatly appreciated.
There isn’t really an official one.
We follow general conventions and depend on the preference of the original author.
A common structure amongst many projects, we have (not all of those folders would be useful)
autotests/ # unit-test and integration tests
src/ # main app/library
doc/ #documentation
po/ #translations
tests/ # manual test scripts or programs
README.md
.git-blame-ignoreRevs # if necessary
CMakeLists.txt # for C++ or Qml
And if you use C++ or Qml, we have a bunch of lints (provided by extra-cmake-modules) and CI metadata .kde-ci.yml file: Infrastructure/Continuous Integration System - KDE Community Wiki.
We don’t have extensive documentation on everything, so another source is actual projects that can act as examples.
2 Likes