kdenlive/dev-docs/contributing.md

0001 # Contributing to Kdenlive
0002
0003 * Create a merge request on GitLab
0004 * Get it reviewed
0005 * Join the Telegram group
0006
0007
0008 ## Coding Guidelines
0009
0010 * Use existing code style
0011 * Write unit tests
0012 * Document unclear parts (e.g. what a QMutex is locking)
0013
0014
0015 ## Release + Branching Model
0016
0017 Kdenlive is following the [KDE Release Schedule][sched] and a new major version
0018 like `20.04` is released every four months. Bugfix releases like `20.04.1` are
0019 released until the next major release arrives.
0020
0021 The branching model in Git works as follows:
0022
0023 * `master` is the most recent development version.
0024 * `release/*` contains release branches like `release/20.04`. Shortly before a
0025   new major version is released, the new release branch is created and we enter
0026   feature and string freeze for final bugfixes and translation of texts. The
0027   version which is effectively released is marked with a tag.
0028 * `work/*` contains work branches. When you start coding a new feature,
0029   do it on a work branch. When it is ready, the work branch is merged
0030   back into master if the merge request has been approved.
0031
0032 Bugfixes for the released versions are added on the release branch and then
0033 merged back to master.
0034
0035 [sched]: https://community.kde.org/Schedules