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
Note
This doc is to create a point of reference for the CONTRIBUTING.md
TLDR Render Engine repos uses GitHub Flow with a modified calver. Create a branch off of the target minor or major.
If there are problems pull against the version tag and develop.
git fetch <repo_url> +refs/tags/<TAG>:<branch>
Primary Branches
main - target minor (yyyy.MM.mm)
yyyy.MM.mm - target major
After you publish a new release
If the release is a minor release no changes are made.
If the new release is a target major. Then you will need to merge the target major into main and create a new major.
Releasing Stables
Main will be latest stable pushed to PyPI (e.g. push to main == pip install render-engine change)
Releasing Major Version
Render Engine uses a modified Calver in the following format YEAR.MAJOR.minor. (reset to one after the new year)
Major releases will be pushed when milestones are completed.
Releasing Minor Versions
Minor stables 2024.1.2, x.x.3, etc are for hotfixes. It shouldn't include new features or address issues not in the previous milestone.
Alphas
Features and development fixes are released in alpha versions marked with x.x.xa1... and should be released based on one or more developmmental changes.
Betas
Beta Releases are for groups of changes which have alpha releases and releaseed before the milestone is complete. This is used to help identify bugs and help with documentaiton and testing.
Betas are marked as x.x.xb1.
Release candidates
Release candidates are created when there are no intended changes that need to be made. These are to help developers of third-party plugins update their projects.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
GitHub Flow
If there are problems pull against the version tag and develop.
git fetch <repo_url> +refs/tags/<TAG>:<branch>
Primary Branches
main
- target minor (yyyy.MM.mm)yyyy.MM.mm
- target majorAfter you publish a new release
If the release is a minor release no changes are made.
If the new release is a target major. Then you will need to merge the target major into main and create a new major.
Releasing Stables
Main will be latest stable pushed to PyPI (e.g. push to main ==
pip install render-engine
change)Releasing Major Version
Render Engine uses a modified Calver in the following format
YEAR.MAJOR.minor
. (reset to one after the new year)Major releases will be pushed when milestones are completed.
Releasing Minor Versions
Minor stables 2024.1.2, x.x.3, etc are for hotfixes. It shouldn't include new features or address issues not in the previous milestone.
Alphas
Features and development fixes are released in alpha versions marked with
x.x.xa1...
and should be released based on one or more developmmental changes.Betas
Beta Releases are for groups of changes which have alpha releases and releaseed before the milestone is complete. This is used to help identify bugs and help with documentaiton and testing.
Betas are marked as
x.x.xb1
.Release candidates
Release candidates are created when there are no intended changes that need to be made. These are to help developers of third-party plugins update their projects.
Beta Was this translation helpful? Give feedback.
All reactions