From 5ab6adec238407d040e5002bd71a90d8ea342746 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Kelemen=20=28vudiq=29?= Date: Tue, 29 Mar 2022 21:51:43 +0200 Subject: [PATCH] update CONTRIBUTING --- CONTRIBUTING.md | 50 ++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e39e9f9cb..7ea65ba54f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ * You are responsible for your own changes, if you break something, you need to fix it * Everybody has to test their own changes * Testing means manual testing on real hardware - * If you are unsure how to contribute code, meet us on IRC (#lakkatv on freenode) or Discord (libretro server) + * If you are unsure how to contribute code, meet us on IRC (#lakkatv on Libera Chat) or Discord (libretro server) * Our users want the latest working versions of RetroArch and the libretro cores. They don't want non working / half working versions. # Team members @@ -16,15 +16,15 @@ Team members: kivutar, Ntemis, gouchi, ToKe79, RobLoach, natinusala, plaidman # The development branch -The development happens on the branch master. This branch follows LibreELEC 8.2 stable. +Current development happens on the branch Lakka-v4.x. This branch follows LibreELEC 10.0 stable. We consider this branch as a rolling release, and we ensure that: - * All the projects build fine at least on Ubuntu 16.04 and 18.04 + * All the projects build fine at least on Ubuntu 20.04 * All the projects boot * All the projects boot to RetroArch -We don't have a stable branch + unstable branches. For now, we only work on master which should be as stable as possible. +We don't have a stable branch + unstable branches. For now, we only work on Lakka-v4.x, which should be as stable as possible. # Pull requests @@ -54,7 +54,7 @@ package-name: update something on the package # Merging upstream -The upstream branch, LibreELEC 9.2, will be merged on a regular basis by the maintainers. Merging upstream should be discussed and announced on IRC in presence of the project leader. +The upstream branch, LibreELEC 10.0, will be merged on a regular basis by the maintainers. Merging upstream should be discussed and announced on IRC/Discord in presence of the project leader. It should be done once every release cycle, at the beginning of the cycle. @@ -78,34 +78,34 @@ During the code freeze: # Good practices guide -This branch is based on [LibreELEC 9.2](https://github.com/LibreELEC/LibreELEC.tv/tree/libreelec-9.2). +This branch is based on [LibreELEC 10.0](https://github.com/LibreELEC/LibreELEC.tv/tree/libreelec-10.0). -After you fork and clone to your local development environment, fetch and switch to branch `Lakka-LE9.2` and add the upstream repository: +After you fork and clone to your local development environment, fetch and switch to branch `Lakka-v4.x` and add the upstream repository: ``` -git fetch origin Lakka-LE9.2:Lakka-LE9.2 -git checkout -b Lakka-LE9.2 origin/Lakka-LE9.2 +git fetch origin Lakka-v4.x:Lakka-v4.x +git checkout -b Lakka-v4.x origin/Lakka-v4.x git remote add upstream https://github.com/libretro/Lakka-LibreELEC git fetch upstream -git branch --set-upstream-to=upstream/Lakka-LE9.2 +git branch --set-upstream-to=upstream/Lakka-v4.x ``` -To update your local Lakka-LE9.2 branch from upstream (do this every time before you create a new branch which you mean to PR): +To update your local Lakka-v4.x branch from upstream (do this every time before you create a new branch which you mean to PR): ``` -git checkout Lakka-LE9.2 -git pull upstream Lakka-LE9.2 -git push origin Lakka-LE9.2 +git checkout Lakka-v4.x +git pull upstream Lakka-v4.x +git push origin Lakka-v4.x ``` -Do not commit anything into Lakka-LE9.2 branch but create branches for each PR, otherwise you will have merge commits when updating from upstream: +Do not commit anything into Lakka-v4.x branch but create branches for each PR, otherwise you will have merge commits when updating from upstream: ``` -git checkout -b Lakka-LE9.2 +git checkout -b Lakka-v4.x ``` To rebase your branch (you might need to resovle some conflicts - do this only when your PR has conflicts with the base): ``` git checkout -git rebase upstream Lakka-LE9.2 +git rebase upstream Lakka-v4.x ``` ## Add LibreELEC repository @@ -114,32 +114,32 @@ To merge commits from the base, LibreELEC repository has to be added: git remote add libreelec https://github.com/LibreELEC/LibreELEC.tv ``` -Lakka-LE9.2 is based on the libreelec-9.2 branch, so fetch it: +Lakka-v4.x is based on the libreelec-10.0 branch, so fetch it: ``` -git fetch libreelec libreelec-9.2:libreelec-9.2 +git fetch libreelec libreelec-10.0:libreelec-10.0 ``` To update the base branch later: ``` -git checkout libreelec-9.2 -git pull libreelec libreelec-9.2 +git checkout libreelec-10.0 +git pull libreelec libreelec-10.0 ``` List of new commits in base branch: ``` -git log Lakka-LE9.2..libreelec-9.2 +git log Lakka-v4.x..libreelec-10.0 ``` If you want to merge up to a specific commit hash or tag: ``` -git checkout libreelec-9.2 +git checkout libreelec-10.0 git reset --hard ``` Create new branch and merge the commits: ``` -git checkout -b update_from_libreelec Lakka-LE9.2 -git merge libreelec-9.2 +git checkout -b update_from_libreelec Lakka-v4.x +git merge libreelec-10.0 ``` Push the changes to your remote repository (and open pull request on GitHub):