plasma/kwin/README.md

0001 # KWin
0002
0003 KWin is an easy to use, but flexible, composited Window Manager for Xorg windowing systems (Wayland, X11) on Linux. Its primary usage is in conjunction with a Desktop Shell (e.g. KDE Plasma Desktop). KWin is designed to go out of the way; users should not notice that they use a window manager at all. Nevertheless KWin provides a steep learning curve for advanced features, which are available, if they do not conflict with the primary mission. KWin does not have a dedicated targeted user group, but follows the targeted user group of the Desktop Shell using KWin as it's window manager.
0004
0005 ## KWin is not...
0006
0007  * a standalone window manager (c.f. openbox, i3) and does not provide any functionality belonging to a Desktop Shell.
0008  * a replacement for window managers designed for use with a specific Desktop Shell (e.g. GNOME Shell)
0009  * a minimalistic window manager
0010  * designed for use without compositing or for X11 network transparency, though both are possible.
0011
0012 # Contributing to KWin
0013
0014 Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to KWin.
0015
0016 # Contacting KWin development team
0017
0018  * mailing list: [kwin@kde.org](https://mail.kde.org/mailman/listinfo/kwin)
0019  * IRC: #kde-kwin on irc.libera.chat
0020
0021 # Support
0022 ## Application Developer
0023 If you are an application developer having questions regarding windowing systems (either X11 or Wayland) please do not hesitate to contact us. Preferable through our mailing list. Ideally subscribe to the mailing list, so that your mail doesn't get stuck in the moderation queue.
0024
0025 ## End user
0026 Please contact the support channels of your Linux distribution for user support. The KWin development team does not provide end user support.
0027
0028 # Reporting bugs
0029
0030 Please use [KDE's bugtracker](https://bugs.kde.org) and report for [product KWin](https://bugs.kde.org/enter_bug.cgi?product=kwin).
0031
0032 ## Guidelines for new features
0033
0034 A new Feature can only be added to KWin if:
0035
0036  * it does not violate the primary missions as stated at the start of this document
0037  * it does not introduce instabilities
0038  * it is maintained, that is bugs are fixed in a timely manner (second next minor release) if it is not a corner case.
0039  * it works together with all existing features
0040  * it supports both single and multi screen (xrandr)
0041  * it adds a significant advantage
0042  * it is feature complete, that is supports at least all useful features from competitive implementations
0043  * it is not a special case for a small user group
0044  * it does not increase code complexity significantly
0045  * it does not affect KWin's license (GPLv2+)
0046
0047 All new added features are under probation, that is if any of the non-functional requirements as listed above do not hold true in the next two feature releases, the added feature will be removed again.
0048
0049 The same non functional requirements hold true for any kind of plugins (effects, scripts, etc.). It is suggested to use scripted plugins and distribute them separately.