Improve README framing and add issue/label maintainer tooling

This commit is contained in:
Sebastian Palencsar
2026-02-23 08:17:59 +01:00
parent 2aca752a51
commit 7869b61836
9 changed files with 408 additions and 9 deletions

72
docs/github-labels.json Executable file
View File

@@ -0,0 +1,72 @@
[
{
"name": "architecture/runtime",
"color": "5319E7",
"description": "Runtime model, shared runtime, config-based apps, install model evolution"
},
{
"name": "distro-compat",
"color": "D93F0B",
"description": "Distro-specific build/runtime issues and environment differences"
},
{
"name": "integration",
"color": "0E8A16",
"description": "Desktop integration topics (.desktop, icons, launchers, window class behavior)"
},
{
"name": "icons",
"color": "FBCA04",
"description": "Favicon fetching, icon parsing, icon quality, and fallback behavior"
},
{
"name": "good first issue",
"color": "7057FF",
"description": "Scoped tasks suitable for first-time contributors"
},
{
"name": "needs testing",
"color": "BFDADC",
"description": "Behavior change needs manual or wider validation across systems"
},
{
"name": "design decision",
"color": "1D76DB",
"description": "Affects long-term architecture or product direction"
},
{
"name": "docs",
"color": "0075CA",
"description": "README, CONTRIBUTING, examples, troubleshooting, and release notes"
},
{
"name": "bug",
"color": "D73A4A",
"description": "Incorrect behavior or regression"
},
{
"name": "enhancement",
"color": "A2EEEF",
"description": "Feature or improvement request"
},
{
"name": "ci",
"color": "C5DEF5",
"description": "GitHub Actions, release workflows, and build checks"
},
{
"name": "feature",
"color": "84B6EB",
"description": "User-facing functionality addition (release note category)"
},
{
"name": "fix",
"color": "E99695",
"description": "Behavior correction or bug fix (release note category)"
},
{
"name": "chore",
"color": "FEF2C0",
"description": "Maintenance tasks and non-user-facing housekeeping"
}
]

46
docs/maintainer-notes.md Executable file
View File

@@ -0,0 +1,46 @@
# Maintainer Notes
This document captures lightweight repo-management conventions for `deskify` during the alpha/MVP phase.
## Issue Labels (Recommended)
Use labels to make project direction visible and to reduce triage friction.
- `architecture/runtime` - runtime model, shared runtime, config-based apps, install model evolution
- `distro-compat` - distro-specific build/runtime issues (WebKitGTK, packaging prerequisites, environment differences)
- `integration` - desktop integration topics (`.desktop`, icons, launchers, window class behavior)
- `icons` - favicon fetching, icon parsing, icon quality/fallback behavior
- `good first issue` - scoped tasks suitable for first-time contributors
- `needs testing` - behavior change needs manual or wider validation across systems
- `design decision` - issue/PR affects long-term architecture or product direction
- `docs` - README, CONTRIBUTING, examples, troubleshooting, release notes
- `bug` - incorrect behavior or regression
- `enhancement` - feature or improvement request
- `ci` - GitHub Actions, release workflows, build checks
Label definitions for GitHub setup are stored in `docs/github-labels.json`.
If you use GitHub CLI, `scripts/setup-github-labels.sh <owner/repo>` will create/update them.
## Triage Heuristics (Alpha)
- Prefer labeling directionally first (`architecture/runtime`, `distro-compat`, `integration`) before priority.
- Use `design decision` early when a discussion can create long-term constraints.
- Add `needs testing` to changes that touch build/install/remove flows or desktop integration behavior.
- Distinguish user-environment issues from code bugs (`distro-compat` + details) to avoid misclassifying support reports.
## Release Notes Categories (Suggested Mapping)
- `feature`, `enhancement` -> user-facing functionality additions
- `fix`, `bug` -> behavior corrections and regressions
- `docs` -> documentation changes
- `chore`, `ci` -> maintenance and pipeline work
## Maintainer Framing (README / Issues)
During alpha, consistently frame Deskify as:
- a Linux-first web app integration tool
- an early MVP with intentional per-app build architecture
- a project with a visible evolution path toward runtime/config-based installs
This helps avoid "Nativefier clone" framing as the default community label.