[edk2-devel] [edk2-wiki][PATCH v1 1/1] Add code formatting to development process instructions

[Michael D Kinney]

Reviewed-by: Michael D Kinney <michael.d.kinney at intel.com>

> -----Original Message-----
> From: michael.kubacki at outlook.com <michael.kubacki at outlook.com>
> Sent: Tuesday, December 14, 2021 7:47 AM
> To: devel at edk2.groups.io
> Cc: Andrew Fish <afish at apple.com>; Leif Lindholm <leif at nuviainc.com>; Kinney, Michael D <michael.d.kinney at intel.com>; Gao,
> Liming <gaoliming at byosoft.com.cn>
> Subject: [edk2-wiki][PATCH v1 1/1] Add code formatting to development process instructions
> 
> From: Michael Kubacki <michael.kubacki at 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 at apple.com>
> Cc: Leif Lindholm <leif at nuviainc.com>
> Cc: Michael D Kinney <michael.d.kinney at intel.com>
> Cc: Liming Gao <gaoliming at byosoft.com.cn>
> Signed-off-by: Michael Kubacki <michael.kubacki at 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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#84939): https://edk2.groups.io/g/devel/message/84939
Mute This Topic: https://groups.io/mt/87723678/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-