-
Notifications
You must be signed in to change notification settings - Fork 0
Recording Changes
Whenever you make changes to the master code, it is important that you create a record of those changes. We follow the standards of Semantic Versioning 2.0.0 (https://semver.org/) as well as using a few additional standards. Once the pull request for your changes have been approved, they should be added to the Changelog with a version number and date proceeding them.
There are three types of versions and the significance of your changes will determine which type you will use. Take a look at past changes in the changelog to get an idea of whether your changes will be considered milestone, major, or minor version change. Typically, each pull request will receive its own version. However, sometimes pull requests submitted on the same day may be combined with each other into a single version or small pull requests might be added to another version.
vMilestone.Major.Minor
Milestone - this version vastly alters gameplay
Major - this version adds a significant feature or improvement
Minor - this version features small changes and bug fixes
All changes that are added to this changelog should also make use of our keywords. The keyword describes the changes affect in terms of the code. Begin every change with one of the following keywords:
Added - new code that did not exist prior
Improved - an improvement to existing code
Removed - removal of existing code
Changed - change in code that does not strictly improve it
Fixed - correction of an error or bug in the code
You may have questions as to what constitutes a milestone version. Each of our games has three milestone versions before the first public release, and could have one or more milestone versions after the release.
V0 "Indev" - active for the first lines of code until the main structure of the game is in place
V1 "Alpha" - active until all main elements of the game are created
V2 "Beta" - active until the first public release is ready
V3 "Gamma" - active for additions and improvements after the first public release
V4 "Delta" - active for a major change to the game after release