Style Guide

User Interface

General Principles

• Follow the GNOME HIG Writing Style
• Use Adwaita's Style Classes
• Mark user-visible strings as translatable (e.g. _("Example"))
• Prefer high-level widgets like Adw.StatusPage and Gtk.Stack
• Prefer properties like Gtk.Box:spacing to Gtk.Widget:margin-top for layout
• Avoid hard-coded height and width, except for e.g. images with fixed geometry
• Prefer HIG terms (Radio Groups, Checkboxes) over technical ones (Checkbuttons)

CSS

General Principles

• Use Adwaita's Named Colors
• Use Adwaita's Style Classes

Formatting

• Use 2-space indentation for all elements
• Use one space between colon and values (e.g. property-name: value;)
• Use double-quotes for strings (e.g. "quoted")

Blueprint

Formatting

• Use 2-space indentation for all elements
• Use one space between colon and values (e.g. property-name: value;)
• Use double-quotes for strings (e.g. "quoted")
• Mark user-visible strings as translatable (e.g. _("Example"))

Object ids

Prefix the object id with the name of the class.

• KO: next_button
• OK: button_next

Child Widgets

// OK
Parent {
  child: Box {
    property-name: value;
  };
}

// NOT OK
Parent {
  child:
    Box {
      property-name: value;
    };
}

Programming

• Use construct-time properties, when possible
• Use properties (eg widget.sensitive) over methods (eg widget.set_sensitive)

JavaScript

General Principles

• Prefer async/await
• Use ESModules for imports
• Do not use async signal handlers, instead use myFunction().catch(logError)
• camelCase for functions for example function openFile
• snake_case for variables/constants for example const button_ok
• Use named functions except for inline callbacks where you should use anonymous functions

General Formatting

• Use 2-space indentation for all elements
• Gio._promisify() should be directly below the import statements

Logging

• All errors should use logError()

Vala

Please see existing code, or ask. Add anything you learn here.

General Principles

• ...

General Formatting

• ...