Define a developer guide

[ponceta]

Description Define a developer guide to ease :

• [x] Development principles around TEKSI modules
• [ ] Modules strategic development choices diversity
• [ ] Crowdsourced contributions

To do :

• [ ] Choose the support and an interface for such a guide, starting on a GitHub Wiki in english for simplicity purposes

Related issues

• [ ] https://github.com/teksi/Home/wiki/TEKSI-Developer-Guide

Related pull requests

• [ ] PR

Related discussion

• [ ] https://github.com/orgs/teksi/discussions/93

[sjib]

Thanks @ponceta for this first draft. I already added a few things and add a list of things to do that can be extended any time:

Additional topics:

• [ ]: General principals: Database uses English terms, value lists with integer values (unique over whole datamodel), relational datamodel (superclass and subclasses), handling of relations, ...
• [ ]: Class table structure od_schema, obj_id attribute, relation between sub and superclass tables, foreignkeys, max length class names
• [ ]: Attribute naming: https://qgep.github.io/docs/user-guide/layerexplanations/namingconventions.html#attribute-names, max length attribute names
• [X] Naming convention vl_ tables - see https://github.com/teksi/Home/wiki/TEKSI-Developer-Guide#value-list
• [ ] maximum length value list names
• [ ] Creation and naming of views: see https://qgep.github.io/docs/user-guide/layerexplanations/namingconventions.html#layer-names
• [ ] Metainformation tables
• [ ] Translation in datamodel
• [ ] ...