[Feature Request] Configuration Guideline for Module Configuration #2217
Description
Goal:
Improve User Experience through a unified and consistent static module configuration in S-CORE.
Problem Statement
Currently, modules are created by different contributors, each following their own experience and style. This leads to inconsistencies in static configuration, such as:
- Different constructs for unique identifiers: Identifier, Specifier, AppName
- Inconsistent naming of configuration variables
- Different storage locations for configuration files
This diversity makes understanding, maintenance, and integration of modules more difficult.
Target Picture
A Configuration Guideline that defines binding rules and best practices for all static configurations to:
- Ensure consistent naming conventions for configuration variables
- Define and use unique identifiers consistently
- Specify the storage location and format of configuration files
- Provide a clear structure for configuration parameters (e.g., mandatory fields, optional fields, default values)
Scope
- Applies to static configurations within S-CORE
- Considers future extensions (e.g., JSON support, FlatBuffers)
Acceptance Criteria
- Documented guideline is available and accessible to all contributors
- Examples of correct application of the guideline are included
- (optional) Automated checks for compliance with the guideline are provided
- All new modules must comply with the guideline
Business Value
- Consistency: Unified configuration improves understanding and reduces errors
- Efficiency: Faster integration of new modules
- Maintainability: Easier maintenance and extension of the system
- User Experience: Clear and predictable configuration for users