EDK II Python development process specification -draft

EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 689 bytes --]

Hi,

The draft specification for EDK II Python development process for presentation made earlier now available .

Presentation thread :

https://edk2.groups.io/g/announce/message/92

Wiki Page link for specification document:

https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Draft-Specification

GitBook link for specification document:

https://edk2-docs.gitbooks.io/edk-ii-python-development-process-speicfication

PDF version can be downloaded from:

https://legacy.gitbook.com/download/pdf/book/edk2-docs/edk-ii-python-development-process-speicfication

Draft version available for 2 week review period and seeking for feedback.

Thanks,

Kondal.

[-- Attachment #2: Type: text/html, Size: 1947 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Sean]

[-- Attachment #1: Type: text/plain, Size: 998 bytes --]

This looks fine but it seems focused on writing a new module/project.  Most python work going into edk2 is part of existing code.
I would like to see additional documentation about how this applies to edk2 basetools.

* A flake8 config file could be added to basetools python.
* Documentation of developer workflows with edk2 basetools
* A plan for how to get edk2 basetools to meet these requirements
* A plan for automated patch verification of meeting these rules.

I have a rule of thumb for code guidelines.  I don't make any rules unless I can enforce them without un-manageable burden.

I also would rather see this type of documentation in the basetools python folder.  There is no reason a developer should have to go looking for this somewhere else within the tianocore site.

Finally, I would suggest we leverage an auto-formatter and provide the config file for that.  This reduces significant burden on the developer and keeps all contributes aligned.

Thanks
Sean

[-- Attachment #2: Type: text/html, Size: 1124 bytes --]

Re: [edk2-devel] EDK II Python development process specification -draft

[Purma, Kondal R]

[-- Attachment #1: Type: text/plain, Size: 627 bytes --]

Thanks for feedback an your are exactly right. This applies for new module/project and every point you mentioned is valid.

We should also make sure these rules applies to bug fixes, or code adding as feature in existing files.

I raised all these question my self and taken initial step.

As a first step,  developed wrapper tool (POC) to apply flake8 on patches only which we can immediately adopt to Basetools etc..

Along with the POC tool(if possible we can make as flake8 plugin) , I will come up with presentation to address all our concerns. We can review and finalize the best practices.

Thanks,
Kondal.

[-- Attachment #2: Type: text/html, Size: 675 bytes --]