From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mx.groups.io with SMTP id smtpd.web08.27000.1641785147526775833 for ; Sun, 09 Jan 2022 19:25:48 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="unable to parse pub key" header.i=@intel.com header.s=intel header.b=kJLchnDB; spf=pass (domain: intel.com, ip: 192.55.52.93, mailfrom: zhiguang.liu@intel.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1641785147; x=1673321147; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=T/j5MrQekW4DJuPpbBtdJ1apgp7LAqn4iRH4CxXVnqg=; b=kJLchnDBUly0PxpJ4//PwMh1GoktgrVxwUpDSUuosDumKvRXD8YgQALK 8gRYwxhrSq6aByLZvupW7vRdOud2SJ4zAMc+zCw3dAVvUEw5/QtRy1OA2 ctKYgVh9Yb1cEs9YKwW+6k1SEPaFzx8tUdqjZQD9B2pgx0MGHNjvJPibj dRlHO76T/bA23HBEhgY+cVC9o0vzPbIPt4Or2yPZLG8G9BFiKiXkEzB0R ca5wdthVncc0eo78oWQrccBwBIpkG2WOlr1KyFoEGzpDFYBVrpzzgqiFJ aRr9V7TqVzNZdMgCmVglhQ88DFVOlh3AaGVWhs+qg0cYZgf2ANxs25PN6 g==; X-IronPort-AV: E=McAfee;i="6200,9189,10222"; a="240694200" X-IronPort-AV: E=Sophos;i="5.88,275,1635231600"; d="scan'208";a="240694200" Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Jan 2022 19:25:46 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.88,275,1635231600"; d="scan'208";a="690430058" Received: from shwdesfp01.ccr.corp.intel.com ([10.239.158.158]) by orsmga005.jf.intel.com with ESMTP; 09 Jan 2022 19:25:45 -0800 From: "Zhiguang Liu" To: devel@edk2.groups.io Cc: Liming Gao Subject: [PATCH] Wiki: Add optional steps for developer to run CI test before sending Date: Mon, 10 Jan 2022 11:25:35 +0800 Message-Id: <20220110032535.232-1-zhiguang.liu@intel.com> X-Mailer: git-send-email 2.32.0.windows.2 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Cc: Liming Gao Signed-off-by: Zhiguang Liu --- EDK-II-Development-Process.md | 60 +++++++++++++++++++++++++++++++++++++++= ++++++--------------- 1 file changed, 45 insertions(+), 15 deletions(-) diff --git a/EDK-II-Development-Process.md b/EDK-II-Development-Process.md index 469a979..747c6e1 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 change= s=0D -=0D - - [EDK-II-Code-Formatting](EDK-II-Code-Formatting "wikilink")=0D -=0D - - The changes must pass local CI which includes a code formatting check= =0D - in order to be merged into the code base.=0D -=0D - - It is strongly recommended that you format the code after each commit= .=0D - The code can then be easily amended with the formatted output. Some=0D - developers might also prefer to format frequently while writing the=0D - code using the plugin instructions described in the code formatting=0D - wiki page.=0D -=0D -10. Create patch (serial) to the [[edk2-devel]] mailing list=0D +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 @@ -86,7 +116,7 @@ The developer process for the EDK II project =20 - `$ git send-email *.patch` =20 -11. Modify local commits based on the review feedbacks and repeat steps=0D +13. Modify local commits based on the review feedbacks and repeat steps 3 to 9 =20 - For the latest commit, you can use `$ git commit --amend` --=20 2.32.0.windows.2