EDK-II-Development-Process.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 52 insertions(+), 17 deletions(-)
V2: Add the step to join in https://edk2.groups.io/g/devel and wait for
approval when first sending patch.
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Zhiguang Liu <zhiguang.liu@intel.com>
---
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
`$ git rebase origin/master`
-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/getting-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). The
+ `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 <developer-id> https://github.com/<developer-id>/edk2.git`
+
+ - Push the integration branch.
+
+ `$ git push <developer-id> <new-integration-branch>`
+
+11. (Optional) Create a GitHub pull request from the developer's
+ <new-integration-branch> to edk2/master to run CI check.
+
+ - How to create a [GitHub pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
+ - **NOTE:** A GitHub pull request can also be created using the command
+ 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
- Clean out any old patches: `$ rm *.patch`
@@ -84,10 +114,15 @@ The developer process for the EDK II project
- Add the `--subject-prefix="PATCH v2"` if you are sending out a
second version of the patch series.
- - `$ 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
-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
- For the latest commit, you can use `$ git commit --amend`
--
2.32.0.windows.2
-=-=-=-=-=-=-=-=-=-=-=-
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]
-=-=-=-=-=-=-=-=-=-=-=-
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn> > -----邮件原件----- > 发件人: Zhiguang Liu <zhiguang.liu@intel.com> > 发送时间: 2022年1月17日 14:03 > 收件人: devel@edk2.groups.io > 抄送: Liming Gao <gaoliming@byosoft.com.cn> > 主题: [Wiki V2] Wiki: Add optional steps for developer to run CI test before > sending > > V2: Add the step to join in https://edk2.groups.io/g/devel and wait for > approval when first sending patch. > > Cc: Liming Gao <gaoliming@byosoft.com.cn> > Signed-off-by: Zhiguang Liu <zhiguang.liu@intel.com> > --- > 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 > > `$ git rebase origin/master` > > -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/getting-started-with-github/fork-a-r > epo) > + - **NOTE:** A GitHub fork can also be created using the command > 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). > + > + - Add remote to the developer's fork of the EDK II project > + > + `$ git remote add <developer-id> > https://github.com/<developer-id>/edk2.git` > + > + - Push the integration branch. > + > + `$ git push <developer-id> <new-integration-branch>` > + > +11. (Optional) Create a GitHub pull request from the developer's > + <new-integration-branch> to edk2/master to run CI check. > + > + - How to create a [GitHub pull > request](https://help.github.com/en/github/collaborating-with-issues-and-pu > ll-requests/creating-a-pull-request) > + - **NOTE:** A GitHub pull request can also be created using the > command > + 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 > > - Clean out any old patches: `$ rm *.patch` > > @@ -84,10 +114,15 @@ The developer process for the EDK II project > - Add the `--subject-prefix="PATCH v2"` if you are sending out a > second version of the patch series. > > - - `$ 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 > > -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 > > - For the latest commit, you can use `$ git commit --amend` > > -- > 2.32.0.windows.2 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#85742): https://edk2.groups.io/g/devel/message/85742 Mute This Topic: https://groups.io/mt/88481389/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=-=-=-=-=-=-=-=-=-=-=-
© 2016 - 2024 Red Hat, Inc.