leapp-to / leapp-actors-stdlib Goto Github PK

Wen registering a group with commands they do not only work as sub command but also overwrite previous commands with the same name (e.g. run vs workflow run)

We need to find out why and if we can get rid of this problem. Also let's check how much effort it would be to replace click with something home made on top of standard libraries things to avoid the necessity to include this library into RHEL

Considering I'm not familiar with the new framework, I might not be able to spot missing points that should be considered best practices. However, I'm listing a few points that I believe would make the document a bit better.

These is just my impressions, so feel free to ignore them. :)

1 Repository directory layout

We might want to move this section to another part of the documentation. It seems those dirs and files are created by the snactor CLI, so the actor developer doesn't need to be instructed where the files should be placed.

If we do allow the developer to place their files in custom directories (e.g. utils in files/), perhaps bullet points could be used in these cases.

2 Guidelines

2.1 Actors are written python

I'm sure these things are to be reviewed yet, but I'll bring them up for completeness.

There are a few "style" points that I would change. For instance, Python sometimes isn't capitalized and some words could be highlighted.

2.2 Avoid running code on module level

Some people might get confused by module level. It might be better to choose a different way of experssing this.

2.3 Use the snactor tool

It could be useful to have a few examples.