1
Fork 0
mirror of https://github.com/redstrate/Astra.git synced 2025-04-22 20:47:45 +00:00
astra/CONTRIBUTING.md

1.4 KiB

Contributing to Astra

I appreciate any code contributions to Astra, whether they are bugfixes or new features! this repository is managed on sourcehut.

Once you finished your changes, use git send-email or the sourcehut web contributor interface to upload them. Please send your patches to ~redstrate/public-inbox@lists.sr.ht.

What Needs Doing

The current TODO list can be located here. It's the best place for feature requests and bug reports.

Where Stuff Is

Everything code-wise for Astra in the /launcher directory. Astra follows modern Kirigami and Qt practices, meaning the frontend is written in QML and the backend is C++.

Backend

The backend code is written in C++, and we're currently requiring C++20 to build.

Frontend

The user interface is written in QML, using technologies such as Kirigami. Please see the KDE API Documentation for more information. The frontend files are located in launcher/ui.

Conventions

Astra follows the standard KDE coding style, which is enforced by the use of clang-format and a git hook. There is nothing else you need to do, please commit any fixes the tool makes.