From mboxrd@z Thu Jan 1 00:00:00 1970 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 Authentication-Results: mx.groups.io; dkim=fail reason="unable to parse pub key" header.i=@intel.com header.s=intel header.b=ZdJkFSzF; spf=pass (domain: intel.com, ip: 192.55.52.43, 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=1642399359; x=1673935359; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=BAZmqdH7jxP/p/WxcfucUUCz6DwZE7I7a0+AloTKCWo=; b=ZdJkFSzF1+dJZCwxtbMI4VUElU4JEOwn0UDY+8eu9alQUgyWFZv6PHAV SN90cFKK/hdtYe8W/bBPAzi3+8fOvBVktZNP/Vr911opqOVnj4Qn85QPp RFiMcXnOwlLk0s3q2d/VqTCNajsUK5CnlQID5220gMPda377XO/GSHn+9 LB/H8d1JFvGGXSr50qj3a2NDhgRhkuuDSYQgiS9mhWwkoTxMwdQ0VG7QV lemb7fov7lmIRVmcctsPFLT+fl0j/lEV5AlbdLN23pRpUODFQhBAgkLN/ yulzPa9W3zkBQcMTCnD9/l73YfywB3SE5aRboD+tRHRiw6X0X3ztou0iA w==; 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" 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" 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: [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> X-Mailer: git-send-email 2.32.0.windows.2 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 --- 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 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 @@ -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=0D - 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