doc: add tools recommendations for examples

Including a reference to flake8 and ruff to find issues
with the code styling of the new examples, and encouraging
users to use isort to order imports.

Change-Id: I128a0d2712d10f39a1debe49bfdb16f24690e493
Pick-to: 6.5
Reviewed-by: Friedemann Kleint <[email protected]>

1 files changed, 16 insertions, 1 deletions

diff --git a/sources/pyside6/doc/developer/add_port_example.rst b/sources/pyside6/doc/developer/add_port_example.rst
index 6ddd1f0f2..d599e50bf 100644
--- a/sources/pyside6/doc/developer/add_port_example.rst
+++ b/sources/pyside6/doc/developer/add_port_example.rst
@@ -10,6 +10,22 @@ You can either design an example from scratch or inspired in another
 application, or simply you can port an existing Qt example that does not have
 a Python counterpart.
 
+For both cases, we recommend you to use tools like
+`flake8 <https://pypi.org/project/flake8/>`_
+(or `ruff <https://pypi.org/project/ruff/>`_) to detect issues with your code.
+Keep in mind we do allow 100 columns for line length.
+Additionally, please use `isort <https://pypi.org/project/isort/>`_ to keep the
+imports ordered and consistent with other examples.
+
+For example:
+
+.. code-block:: bash
+
+  $ flake8 --ignore=E266 your_file.py
+  $ isort your_file.py
+
+
+
 Add a new example
 -----------------
 
@@ -35,5 +51,4 @@ Port a Qt example
   and a screenshot if suitable (use ``optipng`` to reduce file size).
 - Add the ``"""Port of the ... example from Qt 6"""`` doc string.
 - Try to port variable and function names to snake case convention.
-- Verify that a flake check is mostly silent.
 - Remove C++ documentation from ``sources/pyside6/doc/additionaldocs.lst``.