document conventions for contributions

[ms-lolo]

i'd like to create a section in the docs to write down some of the conventions that are forming in the code base. below is a list of examples of the type of things that might be useful for a newcomer to better understand the existing code as well as how to structure new contributions. this ticket is not meant to define the conventions, but to document the existing ones. we can open new issues to discuss the validity of any conventions or any adjustments to them.

• if an environment variable is used, the prefix matches the name of the module that uses it.
  • rats.aml → RATS_AML_SUBSCRIPTION_ID, RATS_AML_WORKSPACE, etc.
• _app.py contains exactly one rats.apps.AppContainer implementation called Application, and the entry point main() function. services are exposed as class variables in AppServices and AppConfigs classes, both made public.
  • rats.aml.AppContainer
  • rats.aml.main
  • rats.aml.AppServices.AML_CLIENT
  • rats.aml.AppConfigs.EXE_GROUP
• will add more over the coming weeks before starting on docs.