Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (92 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

120 lines (92 loc) · 3.53 KB

English | Русский

Contributor's Guide

Thank you for your interest in the project!

Overview

Software Documentation Repository Link
Hyprland https://wiki.hypr.land link
niri https://niri-wm.github.io/niri/ link
Kitty https://sw.kovidgoyal.net/kitty/conf/ link
Ignis https://ignis-sh.github.io/ignis/latest/index.html link

Hyprland

The Hyprland config is divided into smaller configs for better structure and simplicity.

These files also use special styling. Headers are written as:

###
### Title
###

##
## Smaller title
##

# just comment

Similar to callouts in GitHub Markdown, the config has similar comments:

# -- Link -------------------------------------+
# https://wiki.hypr.land/Configuring/Keywords/ |
# ---------------------------------------------+

# (!) Note -------------+
# Please note something |
# ----------------------+

niri

Like Hyprland, niri configuration is divided into small files.

Header notation is similar to Hyprland, but not identical:

///
/// Config File Title
/// <documentation link>

// just comment

/// Header
//// Smaller header
///// Super small header

niri configuration contains optional configs — ignis.kdl and local.kdl. The first is the configuration for Ignis. The second is a local/personal configuration. It's great for running daemons or making personal edits that don't belong in dotfiles.

Ignis

Structure
.config/ignis
├── config.py           # Main file
├── options.py          # Settings [TODO]
├── style.scss          # Styles
└── widgets             # Widgets
    ├── controls/       # Control Center
    ├── clock.py        # Clock widget
    ├── ...
    └── workspaces.py   # Workspaces widget
Basic Commands
  • Run ignis init directly from the console, it's useful for viewing logs
  • ignis inspector for the Gtk inspector

Commit Naming

Naming commits happens in this format: [type] [config]: <description>

  • [type]: the commit type (optional)
    • fix: fix
    • wip: Work In Progress
    • code: code refactoring / visual changes
    • docs: documentation editing (.md files)
  • [config]: where changes happened (optional, if changes are made in the repository root)
    • hypr: Hyprland
    • shell: Ignis shell
    • kitty: Kitty
    • ...: ...
  • <description>: required short commit description

Language Requirements

The following rules apply to all code/configuration:

  • All code/configuration must be in English
  • All user-visible text must be in English

Documentation

Documentation refers to informational .md files in this repository.

  • Documentation is available in two languages: English (priority) and Russian
  • When making changes, verify that the documentation remains accurate
  • Translate to other languages

Contact

If you have questions or suggestions, please open an issue.

Thank you for contributing!