search

o3de / o3de.org

The O3DE website
Other
85 stars 159 forks source link

[DOCS] Python coding standards #2113

Open Kadino opened 1 year ago

Kadino commented 1 year ago

Describe the issue briefly

The contribution guidelines currently do not describe standards for Python code. Standards such as PEP8 should be recommended. This is primarily of concern to SIG-Testing and SIG-Build, as most Python scripts are tests and build scripts.

Which page(s) / section(s) are affected?

https://www.o3de.org/docs/contributing/to-code/

Does this work have an engineering dependency? What is it?

No

Kadino commented 1 year ago

This appears at least partially mitigated by https://github.com/o3de/community/pull/178 mentioning PEP8. It may still be useful to recommend further practices related to subjects such as coding with compatibility for one version of python and cross-platform vs. platform-specific code.