From mboxrd@z Thu Jan 1 00:00:00 1970 X-GM-THRID: 6675607771369439232 X-Received: by 2002:a7b:ce1a:: with SMTP id m26mr140013wmc.16.1554286054415; Wed, 03 Apr 2019 03:07:34 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a1c:b406:: with SMTP id d6ls5036wmf.2.canary-gmail; Wed, 03 Apr 2019 03:07:33 -0700 (PDT) X-Google-Smtp-Source: APXvYqxxQqTWc3VzrOVSI46yRE04rE+nMx/qgMRlB+ilCnT//wAIe3EZ+/BojDLa2t+7J0PxxF6W X-Received: by 2002:a1c:5504:: with SMTP id j4mr141190wmb.1.1554286053930; Wed, 03 Apr 2019 03:07:33 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1554286053; cv=none; d=google.com; s=arc-20160816; b=RmpZDVbgi+/OTsXfurGgGsYKrrumvzuFajnbO+47cTlhFZ2h7gbCMVdKJbd0mq3SlA XXL9rvghNw93jpQ0axTqil/aI0+hfTwwfmj6anmcQwghFvi1EfQKlkQo58dUwAQ+or5e RkioV8xISFH9LQqGkuL3DFNUJTlqdGRp+NgK4v04hApJnV/wL2puDhwe6xUIxBCxrdqs XcG+WoUHR/JmpAfd0bnc0I+vJO8Fwbe5TCJR6JuHxn000O4OZZs6g62Qn/5zuYsVxdbL /DJXQD25u2HtAk4ESAvSt6GcU5VjGz6P7zVeX0v6hAaIEyXeBQui62vUT7MA0laOX+r8 h++g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:date:subject:to:from; bh=49NHo0FMvV0go5fx3/X6BgK8fu07b3wuuoaZgbZcPEk=; b=orjo3Nmip6RevJkBKeGKGvzLQ9Xj0CcZYCxrFyXcp4IkMmK4Hl/HMWH9FyoP4A1/hT x//BGAr6glVmkkDUo+0vgkowrfrknBh/RZlUHArMZyW6siiZQV3QHLMSACpUNlhnf1td zaufs+5KDQzhqJ/85Njl0gZJIXbKQsDYnoXIFYbWfHsrdXGJ5Em09bsJx2SbiKSK1mwK VCDyeEtsKYIPvVhtXf24amW1cDOLJig+cTiJT4oo1ySO3WV7gbK9uqiwGbwzOu8n9ibl r0XWgFFTxENE6G3tF9vAAMHbfsbUoWOHKFaGKOfi/XA8sWgW3qH++GCoF26Ji0rmd/Kr /fuQ== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of mosipov@ilbers.de designates 85.214.156.166 as permitted sender) smtp.mailfrom=mosipov@ilbers.de Return-Path: Received: from shymkent.ilbers.de (shymkent.ilbers.de. [85.214.156.166]) by gmr-mx.google.com with ESMTPS id o3si842818wmf.0.2019.04.03.03.07.33 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 03 Apr 2019 03:07:33 -0700 (PDT) Received-SPF: pass (google.com: domain of mosipov@ilbers.de designates 85.214.156.166 as permitted sender) client-ip=85.214.156.166; Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of mosipov@ilbers.de designates 85.214.156.166 as permitted sender) smtp.mailfrom=mosipov@ilbers.de Received: from azat.m.ilbers.de (host-80-81-17-52.static.customer.m-online.net [80.81.17.52]) (authenticated bits=0) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8) with ESMTPSA id x33A73qt006358 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Wed, 3 Apr 2019 12:07:33 +0200 From: "Maxim Yu. Osipov" To: isar-users@googlegroups.com Subject: [PATCH] isar: Update CONTRIBUTING Date: Wed, 3 Apr 2019 12:07:03 +0200 Message-Id: <20190403100703.6990-1-mosipov@ilbers.de> X-Mailer: git-send-email 2.11.0 X-Spam-Status: No, score=-1.0 required=5.0 tests=ALL_TRUSTED,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shymkent.ilbers.de X-TUID: liJuzRuUOavl This patch * adds CI tests launching procedure description * adds the section "Trunk based development guidelines" * updates maintainers contacts Closes: #45 Signed-off-by: Baurzhan Ismagulov Signed-off-by: Maxim Yu. Osipov --- CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d520902..9ad6bf3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,19 @@ All technical communication about Isar should take place on `isar-users` mailing list. Please be polite and respect opinions and contributions of others. +## Trunk based development guidelines + +We adapt trunk based development technique + +* `master` is the main development branch and not a stable release. + +* `next` is a branch for CI (Continous Integration), testing and early feedback. + +* `next` is sync'ed with `master` once in about two weeks (or more often whenever appropriate). + +If a major problem exists in `master`, it will be handled with priority. +If a major change has been recently merged into `next`, allow time to collect feedback and resolve issues. +Plan merges to `master` so that both fit the two-week window; short extensions should be an exception. ## Development @@ -64,6 +77,35 @@ others. * Seemingly unaffected boards still build. + * It's highly suggested to test your patchset before submitting it to the mailing + by launching CI tests scripts. The procedure is described below: + + First, run "fast" CI +``` + scripts/ci_build.sh -q -f + ... + source isar-init-build-env + scripts/vm_smoke_test -f +``` + Currently "fast" CI launches + * parallel cross build of QEMU arm/arm64/amd64 Debian stretch and Raspberry Pi 1 Raspbian stretch targets + * cross build of one of the supported boards which includes compilation of Linux kernel/U-Boot for it + * Launches login prompt check tests for built QEMU targets + + Second, run standard CI +``` + scripts/ci_build.sh -q + ... + source isar-init-build-env + scripts/vm_smoke_test -q +``` + Currently standard CI launches + * parallel native build of QEMU arm/arm64/i386/amd64 Debian stretch/buster and Raspberry Pi 1 Raspbian stretch targets + * Launches login prompt check tests for built QEMU targets + + Active developers may request from maintainers an account on isar-build.org + to analyze CI logs or to launch their own CI builds there. + 4. Structure patches logically, in small increments. * One separable fix / improvement / addition - one patch. Do not provide @@ -143,7 +185,7 @@ others. * Check with your employer when not working on your own. - * Base patches on top of the lastest master. + * Base patches on top of the latest 'next' branch * Every file should carry the copyright and licensing information: @@ -171,7 +213,7 @@ others. 1. Patches are reviewed on the mailing list. - * At least by maintainters, but everyone is invited, so the process can be + * At least by maintainers, but everyone is invited, so the process can be recurrent. * Feedback has to consider design, functionality and style. @@ -179,10 +221,13 @@ others. * Simpler and clearer code is preferred, even if the original code works fine. -2. After the review, patches are applied to the testing branch and CI checks - are executed. +2. After the review, patches are applied to the maintainers testing branch and + CI checks are executed. + +3. If CI tests are passed OK and no new comments have appeared, + the patches are merged into the `next` branch and later (normally in two weeks) + into `master`. -3. If no new comments have appeared, the patches are merged to master branch. GitHub facilities other than issues are not used for the review process, so that people can follow all changes and related discussions at one stop, the @@ -193,7 +238,7 @@ mailing list. This may change in the future. 1. Maintainers: - * Alexander Smirnov + * Maxim Yu. Osipov * Baurzhan Ismagulov -- 2.11.0