docs: add issue templates, PR template, and labeler config

- Bug report: version, component, repro steps, logs, environment
- Feature request: component, description, alternatives
- Question: with links to docs/Discord
- PR template: summary, type, testing checklist, screenshots
- Labeler: auto-label PRs (python, config, c-backend, styling, ci, docs, assets, install)
This commit is contained in:
sankalp committed 2026-07-12 20:15:33 +05:45
1 parent d4eab2cb34
commit e64ef88f3e
6 files changed
+268

No files matched your search

+86
View File
@@ -0,0 +1,86 @@
name: Bug Report
description: Report a bug in Modus
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please fill out the sections below.
- type: input
id: version
attributes:
label: Modus version
description: "Output of `git rev-parse --short HEAD` or release tag"
placeholder: "e.g. v2.0.0 or abc1234"
validations:
required: true
- type: dropdown
id: component
attributes:
label: Component
description: Which part of Modus is affected?
options:
- Panel / Top Bar
- Dock
- Spotlight / Search
- App Switcher
- Lock Screen
- Notifications / Control Center
- Desktop Widgets
- Global Menu
- Settings / Config
- Installation / Dependencies
- Other
validations:
required: true
- type: textarea
id: description
attributes:
label: Bug description
description: What happened? What did you expect?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Minimal steps to trigger the bug
placeholder: |
1. Open Modus with `uv run start`
2. Press Super+D
3. Type ...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant logs
description: Paste any error output or journalctl logs
render: shell
- type: textarea
id: environment
attributes:
label: Environment
description: |
- Distro / Window Manager:
- Python version:
- GPU / Driver:
value: |
- Distro:
- Python:
- GPU:
validations:
required: true
- type: textarea
id: config
attributes:
label: Config files
description: "Paste contents of `config/config.toml` if relevant (redact sensitive values)"
render: toml
+8
View File
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Discord
url: https://discord.gg/tRFxkbQ3Zq
about: Chat with the community
- name: Documentation
url: https://github.com/S4NKALP/Modus/tree/main/docs
about: Read the docs before opening an issue
+50
View File
@@ -0,0 +1,50 @@
name: Feature Request
description: Suggest a new feature or improvement
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Describe the feature you'd like to see in Modus.
- type: dropdown
id: component
attributes:
label: Component
description: Which area does this relate to?
options:
- Panel / Top Bar
- Dock
- Spotlight / Search
- App Switcher
- Lock Screen
- Notifications / Control Center
- Desktop Widgets
- Global Menu
- Settings / Config
- New Widget
- Spotlight Plugin
- Installation / Packaging
- Other
validations:
required: true
- type: textarea
id: description
attributes:
label: Feature description
description: What should it do? How should it work?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Any workarounds or similar features you know of?
- type: textarea
id: mockups
attributes:
label: Mockups / Screenshots
description: If applicable, attach reference images or screenshots
+22
View File
@@ -0,0 +1,22 @@
name: Question
description: Ask a question about Modus
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Before opening, check the [docs](https://github.com/S4NKALP/Modus/tree/main/docs) and [FAQs](https://github.com/S4NKALP/Modus/blob/main/docs/faqs_tips.md).
- type: textarea
id: question
attributes:
label: Your question
description: What do you want to know?
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Any relevant details about your setup or what you've tried
+44
View File
@@ -0,0 +1,44 @@
## Summary
<!-- What does this PR do? Keep it brief. -->
## Related Issue
<!-- Link: "Closes #123" or "Fixes #123" -->
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Refactor
- [ ] Documentation
- [ ] CI / Build
- [ ] Config / Assets
## What Changed
<!-- Bullet list of key changes -->
## Component(s) Affected
<!-- Panel, Dock, Spotlight, App Switcher, Lock Screen, Notifications, Widgets, Global Menu, Settings, etc. -->
## Testing
<!-- How did you test this? Include commands or steps. -->
- [ ] `uv run pre-commit run --all-files` passes
- [ ] Tested locally on Hyprland
- [ ] Existing functionality not broken
## Screenshots / Videos
<!-- If UI changed, before → after. Delete if not applicable. -->
## Checklist
- [ ] Code follows project style (`ruff` lint + format)
- [ ] No new warnings or errors
- [ ] Docs updated (if applicable)
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
+58
View File
@@ -0,0 +1,58 @@
core:
- label: "bug"
title: "bug"
sync: true
- label: "enhancement"
title: "enhancement"
sync: true
- label: "question"
title: "question"
sync: true
- label: "documentation"
changed-files:
- any-glob-to-any-file:
- "docs/**"
- "**/*.md"
- label: "python"
changed-files:
- any-glob-to-any-file:
- "src/**/*.py"
- "config/plugins/**"
- label: "config"
changed-files:
- any-glob-to-any-file:
- "config/**"
- label: "c-backend"
changed-files:
- any-glob-to-any-file:
- "src/window/switcher/app-capture/**"
- "src/globalmenu/**.c"
- label: "styling"
changed-files:
- any-glob-to-any-file:
- "src/styles/**"
- label: "ci"
changed-files:
- any-glob-to-any-file:
- ".github/**"
- label: "assets"
changed-files:
- any-glob-to-any-file:
- "src/assets/**"
- label: "installation"
changed-files:
- any-glob-to-any-file:
- "install.sh"
- "pyproject.toml"
- "requirements.txt"
- "uv.lock"