Comet

A beautiful git commit message editor for elementary OS.

System requirements

• Elementary OS 6 (Odin)

Developer notes

Getting started

Clone this repository and run the install task:

task/install

You can now run the app from either the Applications Menu or using the run task:

task/run

About

This project is written in Vala and follows the following elementary OS guidelines:

• Human Interface Guidelines
• Developer Guidelines
• Coding style

Please take some time to familiarise yourself with those documents before continuing.

To get your system ready to develop for elementary OS, please see the Basic Setup section of the elementary OS Developer Documentation.

Tasks

Install

Configures and runs the build, installing settings-related features and also refreshing the icon cache.

Run this after you clone this repository to get a working build.

task/install

Build

Builds the project.

task/build

Run

Builds and runs the executable.

task/run

Package

Creates a Flatpak package.

task/package

Run Package

Creates and runs a Flatpak package.

task/run-package

VSCodium

You do not need to use VSCodium to create elementary OS apps.

You can, for instance, use elementary OS Code, which comes preinstalled, or a different third-party editor like Builder.

However, if you do have VSCodium installed, there are a number of extensions that will make creating your elementary OS app easier:

• Vala (codium --install-extension prince781.vala)
• Meson (codium --install-extension asabil.meson)
• CodeLLDB (codium --install-extension vadimcn.vscode-lldb)
• XML (codium --install-extension redhat.vscode-xml)
• YAML (codium --install-extension redhat.vscode-yaml)

If you have the Meson and CodeLLDB extensions installed, you can run and debug the app using the Run and Debug feature (or just hit F5.)

Continuous integration

Continuous Integration is set up for this repository.

Submitting the app

Please make sure you review the AppCenter publishing requirements before submitting the app to the elementary OS AppCenter.

It’s elementary, my dear…

This project was initially generated by Watson, a tool for quickly setting up a new elementary OS 6 app that follows platform human interface and development guidelines.

Acknowledgements

• Comet wallpaper created by Margo de Weerdt.
• Comet icon created using Krita.

Copyright and license

Copyright © 2021-present Aral Balkan

Licensed under GNU GPL version 3.0.