From nobody Thu May 2 06:25:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+85727+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+85727+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1642399361; cv=none; d=zohomail.com; s=zohoarc; b=T/vIrW5b4reQ5HdD6jnwRdXiejw0Fsqjmmvz3xK0TIYCbnOX9RkWk6B8DBRDb+ZyaMehgHzcwNeYQsnQjNDIrOoHSfZNHjg2KRIBNB2aZNTZclEw7OAX6/g1HtE9q5M3tVIKEU7QsLeSV87OIWhg2Dax6RrwIDxi16v8NmJZDw8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1642399361; h=Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=tUKvqenowfrVLrAfHn1qlmCW/HX0hXp2B2/1WAYuSpc=; b=SUeyRhPvw6edcPP+pRs74NmZUVwCHWmvPyok1LirtyGoB4yIK1FfHkp6lSL5yAP8iQwHkPYLM0Qofma1sgxpWKeV1SKxkXpxMFRL2xfVMflB1u3iegbJQlEwaC+mNT/si3bh21nlmuUPLZlwe86IZRtr3IchOMQEgwo3uo3t2C4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+85727+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 164239936130713.448929702797727; Sun, 16 Jan 2022 22:02:41 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id 42k2YY1788612xBJ6JMrrhsv; Sun, 16 Jan 2022 22:02:41 -0800 X-Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mx.groups.io with SMTP id smtpd.web09.7826.1642399359663186569 for ; Sun, 16 Jan 2022 22:02:40 -0800 X-IronPort-AV: E=McAfee;i="6200,9189,10229"; a="330909112" X-IronPort-AV: E=Sophos;i="5.88,294,1635231600"; d="scan'208";a="330909112" X-Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Jan 2022 22:02:38 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.88,294,1635231600"; d="scan'208";a="692954933" X-Received: from shwdesfp01.ccr.corp.intel.com ([10.239.158.158]) by orsmga005.jf.intel.com with ESMTP; 16 Jan 2022 22:02:37 -0800 From: "Zhiguang Liu" To: devel@edk2.groups.io Cc: Liming Gao Subject: [edk2-devel] [Wiki V2] Wiki: Add optional steps for developer to run CI test before sending Date: Mon, 17 Jan 2022 14:02:34 +0800 Message-Id: <084f67a9eecea828c8d03f5273ddbdaae170a4da.1642399328.git.zhiguang.liu@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,zhiguang.liu@intel.com X-Gm-Message-State: KeCuLwIKXaVmotE4f8382J8Tx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1642399361; bh=pMHLII1VLAIfZ8RNn5Hpzq9miiwVeX+GQUM+YEao3pc=; h=Cc:Date:From:Reply-To:Subject:To; b=dVrj7IVVKblfSoFBECnn/V0TfSzv2DmHheP/QJKEPPXkblYpnXhwOBKSbdELJ7Z3yhZ KQhXRbXBHuAI2afmlXkkcN3Ici+3DItItxY2hfCTugiK7amwxV0QQMIacUp6vSQ5Euk/y 6xy7lWv7wMLdfNMJDWu3F1vHuE6TPG722mY= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1642399363123100002 Content-Type: text/plain; charset="utf-8" V2: Add the step to join in https://edk2.groups.io/g/devel and wait for approval when first sending patch. Cc: Liming Gao Signed-off-by: Zhiguang Liu Reviewed-by: Liming Gao --- EDK-II-Development-Process.md | 69 +++++++++++++++++++++++++++++++++++++++= +++++++++++++----------------- 1 file changed, 52 insertions(+), 17 deletions(-) diff --git a/EDK-II-Development-Process.md b/EDK-II-Development-Process.md index 469a979..d02baa7 100644 --- a/EDK-II-Development-Process.md +++ b/EDK-II-Development-Process.md @@ -59,20 +59,50 @@ The developer process for the EDK II project =20 `$ git rebase origin/master` =20 -9. Run the automated code formatting tool (Uncrustify) against your changes - - - [EDK-II-Code-Formatting](EDK-II-Code-Formatting "wikilink") - - - The changes must pass local CI which includes a code formatting check - in order to be merged into the code base. - - - It is strongly recommended that you format the code after each commit. - The code can then be easily amended with the formatted output. Some - developers might also prefer to format frequently while writing the - code using the plugin instructions described in the code formatting - wiki page. - -10. Create patch (serial) to the [[edk2-devel]] mailing list +9. Run the automated code formatting tool (Uncrustify) against your changes + + - [EDK-II-Code-Formatting](EDK-II-Code-Formatting "wikilink") + + - The changes must pass local CI which includes a code formatting check + in order to be merged into the code base. + + - It is strongly recommended that you format the code after each commit. + The code can then be easily amended with the formatted output. Some + developers might also prefer to format frequently while writing the + code using the plugin instructions described in the code formatting + wiki page. + +10. (Optional) Push changes to the developer's fork of the EDK II project + repository. + + - How to create a [GitHub fork](https://help.github.com/en/github/gett= ing-started-with-github/fork-a-repo) + - **NOTE:** A GitHub fork can also be created using the command line + utility called [`hub`](https://github.com/github/hub/releases). T= he + `hub` usage information can be found [here](https://hub.github.com= /hub.1.html). + + - Add remote to the developer's fork of the EDK II project + + `$ git remote add https://github.com//edk= 2.git` + + - Push the integration branch. + + `$ git push ` + +11. (Optional) Create a GitHub pull request from the developer's + to edk2/master to run CI check. + + - How to create a [GitHub pull request](https://help.github.com/en/git= hub/collaborating-with-issues-and-pull-requests/creating-a-pull-request) + - **NOTE:** A GitHub pull request can also be created using the comm= and + line utility called [`hub`](https://github.com/github/hub/releases= ). + The `hub` usage information can be found [here](https://hub.github= .com/hub.1.html). + + - Declare that it is for CI check test in the pull request title and + description. + + - Resolve GitHub pull request issues if it fails. Please refrence step= 8 + in the below **The maintainer process for the EDK II project** + +12. Create patch (serial) to the [[edk2-devel]] mailing list =20 - Clean out any old patches: `$ rm *.patch` =20 @@ -84,10 +114,15 @@ The developer process for the EDK II project - Add the `--subject-prefix=3D"PATCH v2"` if you are sending out a second version of the patch series. =20 - - `$ git send-email *.patch` + - `$ git send-email *.patch --to devel@edk2.groups.io` + + - If it is the first time to send mail to edk2 mail list, please join + https://edk2.groups.io/g/devel and expect there will be delay because + the mail needs manual approval from the admin (gaoliming@byosoft.com= .cn + or michael.d.kinney@intel.com) of https://edk2.groups.io/g/devel =20 -11. Modify local commits based on the review feedbacks and repeat steps - 3 to 9 +13. Modify local commits based on the review feedbacks and repeat steps + 3 to 11 =20 - For the latest commit, you can use `$ git commit --amend` =20 --=20 2.32.0.windows.2 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#85727): https://edk2.groups.io/g/devel/message/85727 Mute This Topic: https://groups.io/mt/88479281/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-