-
-
Notifications
You must be signed in to change notification settings - Fork 393
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
Reorganize version categories to only include major versions #349
Merged
Calinou
merged 10 commits into
godotengine:master
from
svetogam:reorganize-version-categories
Oct 17, 2024
Merged
Reorganize version categories to only include major versions #349
Calinou
merged 10 commits into
godotengine:master
from
svetogam:reorganize-version-categories
Oct 17, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In case I wasn't clear, I'm ready to merge this. I won't do the "further improvement" right now because it's not clear to me that it would really be an improvement. |
Open
Calinou
reviewed
Oct 17, 2024
Calinou
approved these changes
Oct 17, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
This was referenced Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changes version headers to only include major versions and reorganizes items accordingly, as proposed in #343.
Most version information given in parentheses has been removed. But plugins/scripts and modules that support 2 major versions (such as Godot 3 and Godot 4) still make this note in parentheses and italics: (Godot 3 and 4). The idea is that this kind of parenthetical note is only given for information that is exceptional to what the headers imply. It's italicized to make it easy to notice that the Godot 4 section contains items that support Godot 3 too. I think the italics clarify this strongly enough that I did not have to add the explicit clarifying statement "(Sorted by latest compatible major Godot version.)" next to the header, which I previously proposed. This explicit statement is only in CONTRIBUTING.md.
I'm satisfied that this is an improvement, but it now occurs to me that parenthetical version information could be removed entirely with what might be a better system. This would be to, for plugins/scripts and modules only, use the headers "Godot 4 only", "Godot 3 only", and "Godot 3 and 4". I think this would be a further improvement, but it's more unclear and involves a tradeoff. I can modify the PR to do this, or it can be merged without it.
Benefits of this further change:
Downsides:
Example
Plugins and scripts
Scripts that let you do new stuff, or enhance Godot functionality.
Godot 4 Only
Godot 3 and 4
Godot 3 Only