From: "Michael Kubacki" <michael.kubacki@outlook.com>
To: devel@edk2.groups.io
Cc: Andrew Fish <afish@apple.com>, Leif Lindholm <leif@nuviainc.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <gaoliming@byosoft.com.cn>
Subject: [edk2-wiki][PATCH v1 1/1] Add code formatting to development process instructions
Date: Tue, 14 Dec 2021 10:47:19 -0500 [thread overview]
Message-ID: <MWHPR07MB34409B0C2396CB8E960EE32CE9759@MWHPR07MB3440.namprd07.prod.outlook.com> (raw)
From: Michael Kubacki <michael.kubacki@microsoft.com>
Adds a step to the development process instructions to account for
code formatting since it is now a required part of the contribution
process.
Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
Notes:
Rendered diff:
https://github.com/makubacki/tianocore.github.io/commit/42ca5959541393070cc9be380edcea6f341427a0?short_path=17579ba#diff-17579ba0854da983120baa5c2060294e6701dac24ecf1c75c9d94d08b869b02b
EDK-II-Development-Process.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/EDK-II-Development-Process.md b/EDK-II-Development-Process.md
index 4fd202c40c63..6e2c00fccff9 100644
--- a/EDK-II-Development-Process.md
+++ b/EDK-II-Development-Process.md
@@ -59,7 +59,20 @@ The developer process for the EDK II project
`$ git rebase origin/master`
-9. 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. Create patch (serial) to the [[edk2-devel]] mailing list
- Clean out any old patches: `$ rm *.patch`
@@ -73,7 +86,7 @@ The developer process for the EDK II project
- `$ git send-email *.patch`
-10. Modify local commits based on the review feedbacks and repeat steps
+11. Modify local commits based on the review feedbacks and repeat steps
3 to 9
- For the latest commit, you can use `$ git commit --amend`
--
2.28.0.windows.1
next reply other threads:[~2021-12-14 15:47 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-14 15:47 Michael Kubacki [this message]
2021-12-15 22:37 ` [edk2-wiki][PATCH v1 1/1] Add code formatting to development process instructions Michael D Kinney
2021-12-15 22:42 ` Michael D Kinney
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=MWHPR07MB34409B0C2396CB8E960EE32CE9759@MWHPR07MB3440.namprd07.prod.outlook.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox