Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming for plugins/scheme implementations. #123

Open
setrofim opened this issue Feb 28, 2023 · 3 comments
Open

Naming for plugins/scheme implementations. #123

setrofim opened this issue Feb 28, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@setrofim
Copy link
Collaborator

Currently, scheme and plugin names have been created on ad-hoc basis. However, as these names are a part of the overall "interface" exposed by Veraison, we should cosider naming more carefully. A naming scheme should be devised and documented; we should also modify existing code base to adhere to the scheme.

The naming scheme should consider:

  • Avoiding collisions between differnt plugin creators (e.g. prefix sheme with a vendor name , e.g. veraison/psa to distinguish from other PSA-based scheme plugins).
  • Consistent use of suffixes and prefixes, and separators thereof, in the names to indicate different aspects of the schemes, such as the technology used (e.g. TPM).
@setrofim setrofim added the enhancement New feature or request label Feb 28, 2023
@setrofim
Copy link
Collaborator Author

This is part of a larger goal of nailing down our plugins interface. See also: #120

@thomas-fossati
Copy link
Contributor

This is part of a larger goal of nailing down our plugins interface. See also: #120

Just to clarify: are you saying that the naming scheme should include versioning as well (e.g., veraison/psa/v1.0.0)?

@setrofim
Copy link
Collaborator Author

setrofim commented Feb 28, 2023

Just to clarify: are you saying that the naming scheme should include versioning as well (e.g., veraison/psa/v1.0.0)?

Possibly but not necessarily. I'm just indicating that both the naming and the versioning of plugins are part of their "inteface", and we need resolves both of them as part of defining that. Whether or not versioning should be part of the name is an open question (I can see arguments both for and against).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants