Schneegans/Burn-My-Windows

Add KWin contribution guide

Open

#435 opened on Apr 5, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (2,374 stars) (63 forks)batch import
KDEcontributions welcomedocumentationgood first issue

Description

The Idea

Hey! I was just curious what the status is on KWin stability for the making effects / contributing on KWin will be implemented? I know essentially nothing about GLSL but I want to learn then try a few things out with making my own effects.

The Alternatives

Me figuring it all out on my own lol

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of KWin scriptingwillingness to learn GLSL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look at the existing KWin scripting documentation and the Burn My Windows repository structure. Investigate how other KWin projects organize their contribution guides. Check if there are any comments in the issue suggesting specific aspects to cover, such as effect structure or testing. The guide should explain how to set up a development environment for KWin effects and provide step by step instructions for creating a simple effect.