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

Rename 'SvgRenderingTemplate2023' type to 'SvgRenderingTemplate' #4

Open
dmitrizagidulin opened this issue Oct 25, 2023 · 7 comments
Open

Comments

@dmitrizagidulin
Copy link
Collaborator

I strongly feel that we should drop the year from the template type. (it's not a crypto suite, there's no need to denote "freshness" in the type, and we're moving away from years in crypto suites too).

@TallTed
Copy link
Contributor

TallTed commented Oct 26, 2023

I'm generally OK with moving away from years, but versioning often matters, even apart from "freshness". Are we certain that SvgRenderingTemplate will never have two competing versions, such that we'll wish there were SvgRenderingTemplateV1 and SvgRenderingTemplateV2 or the like?

@BigBlueHat
Copy link

If we're going to version these, the year approach doesn't seem too terrible.

@TallTed
Copy link
Contributor

TallTed commented Mar 21, 2024

the year approach doesn't seem too terrible

As long as we're reasonably certain there will never be two versions in one year with a breaking change between them.

@davidlehn
Copy link

I don't think the intent with the year suffix was to process with semantic versioning code. Mostly was to give people a general era and sequence idea, but I forget the full reasoning we had years ago. The hope was these types of things change rarely, but there's no harm in adding a 2023v2, 2023B, or similar as needed.

@dmitrizagidulin
Copy link
Collaborator Author

To me, the likelihood of there being two different templates within a year (or even a decade), with the same name, is very low. If one really needs to do a breaking change, just name it something else.

@BigBlueHat
Copy link

@dmitrizagidulin SvgRenderingTemplateSorryAboutEarlier? 😁

@dmitrizagidulin
Copy link
Collaborator Author

@dmitrizagidulin SvgRenderingTemplateSorryAboutEarlier? 😁

lol YES! Much better!

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

No branches or pull requests

4 participants