You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Definition: Old configuration files should still work with future stable Parsec versions, with the same default for optional options.
Enforcement: Configuration options should not disappear in future stable Parsec versions. Configuration defaults should remain the same. New options should be optional.
Enforcement Check
This can only be done through testing/code review. The config file contains its own documentation regarding field description and defaults.
The Parsec Configuration page could maybe be used to formalize that? But that is duplication of information.
Warning could maybe be set in the code as comments, or in the CI when those parts are modified? If they are put in their own files we can specifically check when the file is modified.
Testing
All the options in the config.toml file should be tested and verified accross different Parsec versions. That includes the "behaviour" of some fields. Defaults should be checked as well.
The text was updated successfully, but these errors were encountered:
Could use similar way as described in #382: put all config structures in one file that is code owned.
All possible options and defaults should be checked in config tests for every PR.
Definition: Old configuration files should still work with future stable Parsec versions, with the same default for optional options.
Enforcement: Configuration options should not disappear in future stable Parsec versions. Configuration defaults should remain the same. New options should be optional.
Enforcement Check
This can only be done through testing/code review. The config file contains its own documentation regarding field description and defaults.
The Parsec Configuration page could maybe be used to formalize that? But that is duplication of information.
Warning could maybe be set in the code as comments, or in the CI when those parts are modified? If they are put in their own files we can specifically check when the file is modified.
Testing
All the options in the
config.toml
file should be tested and verified accross different Parsec versions. That includes the "behaviour" of some fields. Defaults should be checked as well.The text was updated successfully, but these errors were encountered: