Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (53 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

68 lines (53 loc) · 2.88 KB
Raw

Contributing

Thanks for helping improve dwm-titus. Changes should preserve the small X11 window-manager core, existing user workflows, and the Fedora-only desktop target. Fedora Linux is the sole supported distribution.

Before You Start

  • Read AGENTS.md for repository conventions, SPEC.md for product scope, ROADMAP.md for phase outcomes, and TASKS.md for active work.
  • Search existing issues and pull requests before starting overlapping work.
  • Keep durable requirements in SPEC.md; do not copy future roadmap phases into TASKS.md before they become active.
  • Do not commit config.h, build products, release artifacts, ISO images, or generated mdBook output.

Development Setup

On the supported Fedora release, install the repository's Fedora build dependencies, then run:

make clean
make
scripts/run-tests

Use ./install.sh --dry-run --non-interactive --profile core to inspect the dependency plan without changing the system.

Validation

Run the smallest relevant checks while developing and the aggregate gate before submitting a pull request.

Change Required validation
C or build configuration scripts/run-tests make clean all, then scripts/run-tests
Shell or installer scripts/run-tests make check-shell check-format and focused tests
X11 behavior scripts/run-tests make check-xvfb-runtime check-monitor-tags
Quickshell QML scripts/run-tests make check-quickshell-qml plus real or nested X11 runtime validation
Documentation mdbook build docs
Installer or package mapping scripts/run-tests make check-fedora-packages on Fedora 44
Fedora Kickstart or ISO scripts/run-tests make check-kickstart plus all evidence required by SPEC.md Section 9.4
Release automation scripts/run-tests make release-check and a dry run of the release helper

Fedora package, VM, and X11 checks require their documented host tools. If a required environment is unavailable, state exactly what was not tested in the pull request instead of claiming universal validation.

Change Guidelines

  • Preserve the C99 style and avoid new mandatory dependencies unless they are available on supported Fedora releases.
  • Keep POSIX scripts under #!/bin/sh; use Bash only for scripts that need Bash features.
  • Preserve existing config.h, XDG user configuration, and .xinitrc files.
  • Keep Quickshell integrations event-driven when a signal, stream, watch, IPC, or service API exists.
  • Update user documentation, migration notes, and CHANGELOG.md when behavior, commands, dependencies, or defaults change.
  • Add focused regression coverage for bug fixes.

Pull Requests

Use a focused branch and describe the problem, root cause, behavior change, validation, Fedora coverage, and remaining risk. Screenshots are useful for visible UI changes, but do not replace runtime validation.