From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM11-BN8-obe.outbound.protection.outlook.com (NAM11-BN8-obe.outbound.protection.outlook.com [40.92.20.28]) by mx.groups.io with SMTP id smtpd.web10.27352.1639496874243405011 for ; Tue, 14 Dec 2021 07:47:54 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@outlook.com header.s=selector1 header.b=KZMP+oxz; spf=pass (domain: outlook.com, ip: 40.92.20.28, mailfrom: michael.kubacki@outlook.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=JC6HPw7RblA5jEn8ekbBmpLBno1luFC86jXdo+9WHCL5CiMq4Iw3Lr0Z7xRWCK/MadXsVtRk89PwniL4t9MgokHC7ifoRfjhwm/UFAvfCLIGkEhU/J6E/HWyWU3lR5yGNhfvGDJ94Whuvi8snEIGhTy3Cyaqcv8WsDypn6i+OCP2WUI/TJf6eFMgXwEXHJJg5E/5EHHBUJqK0HwGPPRcq0Of0kunn5Jo26Geap0Lr7eEJsuTppB2DmfTnlzVoRtoVpYn2wXIuntpc8gHzoc9Hs017oPQEVWS4nRadD71fmDr2NShr09Q6eCvtctrR6z8AmZyrJrop9r70LXxCMglFg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=pqcWaJchoQsz5EnUmfM9NAVkz8Ix0j4Nmf6r9FIp2jQ=; b=oGFoy1NzoHuJImFQIEekVvzDleE98YWTNEbzQTPwvEakZbKy3PHpwjL7oHi0Qg5FA6himHNeWgWBopF4pe1/w08fwVKLse9YPW3DXJhqqk5znbWqygG3/DX4J9WYAOaK6yKKob/BffzuYKQe3kGRDMpV9HcDXO2tevL6FAQBrmOx6faI5HjNZ1JPSpj3EVPN7Hn1DQnmjJ+z/LDL37Ah0Uzkjoxt8yhwT97ixfuM/2tj2c+gawgrbFVhGWDHadFbrfxTH1RR6YfzOr3dQ/tfmeNfItG08oXz4zkFZmYNDeMo+7KENbuDbk5AP5KgY6WyFK6hTyRuPpvxqSIAqDFi6g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=pqcWaJchoQsz5EnUmfM9NAVkz8Ix0j4Nmf6r9FIp2jQ=; b=KZMP+oxzBlnKw/J3buAls1KOiWX3QpGfe+MMYSHTVhDrwjY86eQipPSspTxBlCEJiWEmywL7fP/HnMI++dvkAH8EFZUf80NBBD4MXc2QOLKzO+G1ifYDpolnNGO2RsdDZhr5A5f0O02RwXb1cl0BWSxHq3M84IZNnQtGlUHcYGqq/UDHXBQk6nhnggaMJek5wqOuhaZYQfmlVqQDLFd51bSSp7rmqnn8mOBewwaPU0ZZhEaPJruOJTrqkos5J/ZjNlFvH642HSRyVflMTGlZ6RC8IwzhU6AMxzEUl2kMKtMyKuk0VC1+uBOmabSK6XfcBeS/3+EMtf27ljfOyLrhlg== Received: from MWHPR07MB3440.namprd07.prod.outlook.com (2603:10b6:301:69::28) by MW4PR07MB8441.namprd07.prod.outlook.com (2603:10b6:303:ba::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4778.11; Tue, 14 Dec 2021 15:47:52 +0000 Received: from MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::75d8:b961:c6c3:e97e]) by MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::75d8:b961:c6c3:e97e%7]) with mapi id 15.20.4778.018; Tue, 14 Dec 2021 15:47:52 +0000 From: "Michael Kubacki" To: devel@edk2.groups.io CC: Andrew Fish , Leif Lindholm , Michael D Kinney , Liming Gao Subject: [edk2-wiki][PATCH v1 1/1] Add code formatting to development process instructions Date: Tue, 14 Dec 2021 10:47:19 -0500 Message-ID: X-Mailer: git-send-email 2.28.0.windows.1 X-TMN: [ttQ/ITLK+tMGIu3Lh0w9rBnRi8mGlr1/ql+EGLD2EJKlDkXpx4TPXX+vO9JHDJBU] X-ClientProxiedBy: BN8PR15CA0046.namprd15.prod.outlook.com (2603:10b6:408:80::23) To MWHPR07MB3440.namprd07.prod.outlook.com (2603:10b6:301:69::28) Return-Path: michael.kubacki@outlook.com X-Microsoft-Original-Message-ID: <20211214154719.832-1-michael.kubacki@outlook.com> MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 556c349e-d108-48bf-34a4-08d9bf19167c X-MS-TrafficTypeDiagnostic: MW4PR07MB8441:EE_ X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: wqxcVIO85RUpRIKcV2ZDnEsrxrWhzB01j3DWnT5XjpnAdwRCKYtTa+wRq1jYn1eKP52mQy2ww9OX2I3UTvRENG9rSzJRJW0gghUCrhBzPipJLiNahtj4idqLr4Ao876TT3dcH6MIAmxRBM7yGvYU7J88w1ODxPLZKPq4UPe4MHOB1d2cV0gbBCWILtz8ipEwoEf9gVeh8apl26Ub2RuzlpVLkwgCKnN/MwOL7VJFOvD7fFPhPdpyUPYv7vhcUDOmA72Gv0IkPT0Ex2hl3bDLsyvuzwKaRIh+6FiXlE6BgxzY4Uzw30qy8WrsN9XH2bY/uzZqe30QecCKqPL3x49fXWTYQgifFLjR8e/430+WZ8R8gSReyMspLJ2u1QsJJGyRQH2/jkS4RmgS1qAiubsm1Q226FoViZMf/auok5ls063T3oGaoj6Pl2fh4sEjDmAsYYa3BC/8pxisxD2ErWRoGaXJOM51/l4kqjzpGnViemxpoVwT5ICyIWQUEB1QRyOAzPozY6DGMpJtbHgRj1NoAgt+Yvsed+DKEGA6AfwGw4OMp7gPDHEH0Lx9Gr5+16OTqC0Z1uLzArvZb5I3y7K/TYXyI6c3TkfCyLVHm6UWj06brAFyZ8/vm/HSBx1RVopm X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Ojfi7sjT9jRhj8Od/EYKt1gRsirD6S5E+WwP5OAyijnVsgTT2w8laYIM0Wnl?= =?us-ascii?Q?mq7rHZikOCwb5SWpnKaBf0Dm/O6JL8iCUMUXBI9lN9+GbLhMRZ5oIWPx8puT?= =?us-ascii?Q?t3MEY2FPk2XMlqiX3McqfCaBN6/CAdXPcQhtZjccdFlJi/8HOwz4Gqc5zK0+?= =?us-ascii?Q?ojDYY54P/HEVJZaWhD91LJvASc0QohMKgsDI9k1xNJGrI5CeKP3bHzRVXoEv?= =?us-ascii?Q?BRgIobHm4PZOpxqOgYSL3Ns+HD/9PVtNckA+sz7aZTmjywFrdEAxliwHIe6g?= =?us-ascii?Q?jBqT41EJeR3EQf14ZGK6cR9rknDLqT9vPf8+c0C74Ht2esCwa+ieO39XFCH3?= =?us-ascii?Q?BZFPHdZTBl3QXCyzxdCmE6HLZ+aMzmrJ4nVTRmiXoSKM0xfj2GEpGhDU3MKT?= =?us-ascii?Q?sxdT+HA/MjDQqOFQfQ/F+3JW4Y8nxuhztjfWOQEdMWH245hSmwdT/dWwVgj6?= =?us-ascii?Q?eZ6sVRmywn9xta+U88NKzv/zOZjG7ci3uhz53OdGlt8f5rz2yBfLWfFrsju9?= =?us-ascii?Q?3CFqevOP007Pg0n1+L8oHPfWprYJxd1LxdIm5y//t93ko9tUKoknwKc+f6yu?= =?us-ascii?Q?zdymOkfcdaCDMZRi4vQobC8XepU/IjKb0mgZZbTLPyqP53FCW9vUQv4Cz+k+?= =?us-ascii?Q?ylI4MQZGMKGgRbsGp8niwre2WWZqxV+8ab0nPL67KG4dbfP/xxLF+z51DSJH?= =?us-ascii?Q?wpcD34EddNWQu9X9u4uIvGjyW4R533JQtVs2ZNKxfOlDwSh0I/JRkBTD8TDT?= =?us-ascii?Q?/HdTvzyNByrlEj4L9STg0F2SIxikuM5PTbIVi2rWTEpzzmlRQT/RX67BHMVh?= =?us-ascii?Q?dNkmbufksTaf14YFDovzVdUnG93AnlOKhA67x3ZrS8XQYksEzWk8HgQBHocD?= =?us-ascii?Q?nwII/oa7NDpo9vl/CpCAdT3SF/Av7WmE/xa0iTROWXsY2WzrA0KFDsNx7L5W?= =?us-ascii?Q?YElnoWfFF1k3de6z+03C9IiTPbP9PbnHuQCkNNoBtN01crvHtPpESTOz+Ecr?= =?us-ascii?Q?ILo3?= X-OriginatorOrg: outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 556c349e-d108-48bf-34a4-08d9bf19167c X-MS-Exchange-CrossTenant-AuthSource: MWHPR07MB3440.namprd07.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Dec 2021 15:47:52.6805 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR07MB8441 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain From: Michael Kubacki 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 Cc: Leif Lindholm Cc: Michael D Kinney Cc: Liming Gao Signed-off-by: Michael Kubacki --- Notes: Rendered diff: https://github.com/makubacki/tianocore.github.io/commit/42ca59595413930= 70cc9be380edcea6f341427a0?short_path=3D17579ba#diff-17579ba0854da983120baa5= c2060294e6701dac24ecf1c75c9d94d08b869b02b 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 =20 `$ git rebase origin/master` =20 -9. Create patch (serial) to the [[edk2-devel]] mailing list +9. Run the automated code formatting tool (Uncrustify) against your change= s + + - [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 =20 - Clean out any old patches: `$ rm *.patch` =20 @@ -73,7 +86,7 @@ The developer process for the EDK II project =20 - `$ git send-email *.patch` =20 -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 =20 - For the latest commit, you can use `$ git commit --amend` --=20 2.28.0.windows.1