astra/CONTRIBUTING.md

# Contributing to Astra

I appreciate any code contributions to Astra, whether they are bugfixes or new features! this repository is managed on [GitHub](https://github.com/redstrate/Astra).

## What Needs Doing

The current TODO list can be located [here](https://github.com/redstrate/astra). It's the best place for feature requests and bug reports.

## Where Stuff Is

Everything code-wise for Astra in the [/launcher](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](https://api.kde.org/) for more information. The frontend files are located in [/launcher/ui](launcher/ui).

## Conventions

Astra follows the standard KDE coding style, which is enforced by the use of [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and a git hook. There is nothing else you need to do, please commit any fixes the tool makes.
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`# Contributing to Astra`

Update README, BUILDING, CONTRIBUTING and add FUNDING.yml 2024-04-22 16:39:25 -04:00			`I appreciate any code contributions to Astra, whether they are bugfixes or new features! this repository is managed on [GitHub](https://github.com/redstrate/Astra).`
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00
			`## What Needs Doing`

Fix more links to point towards GitHub 2024-05-22 19:21:11 -04:00			`The current TODO list can be located [here](https://github.com/redstrate/astra). It's the best place for feature requests and bug reports.`
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00
			`## Where Stuff Is`

Fix links in CONTRIBUTING 2023-08-18 14:59:04 -04:00			`Everything code-wise for Astra in the [/launcher](launcher) directory. Astra follows modern Kirigami and Qt practices, meaning the frontend is written in QML and the backend is C++.`
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00
			`### Backend`

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

			`### Frontend`

Hmm maybe actually fix the link in contributing document 2024-03-23 09:58:07 -04:00			`The user interface is written in QML, using technologies such as Kirigami. Please see the [KDE API Documentation](https://api.kde.org/) for more information. The frontend files are located in [/launcher/ui](launcher/ui).`
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00
			`## Conventions`

Update README, BUILDING, CONTRIBUTING and add FUNDING.yml 2024-04-22 16:39:25 -04:00			`Astra follows the standard KDE coding style, which is enforced by the use of [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and a git hook. There is nothing else you need to do, please commit any fixes the tool makes.`