- Tag a commit in the repository with the format of
v*.*.*
for production releases, and a tag ofv*.*.*-qa.*
for QA / test releases. For example,v1.6.2-qa.3
. - Push the tag to origin
- The
release.yml
action should create a draft release, with the game'srbxl
file automatically attached to it. - Add a description to the draft release. Typically this will be release notes.
- Publish the release as either a full release or a pre-release.
- The
deploy.yml
action will deploy the place file to either your production environment or your test environment, depending on the naming of the tag. - Your game is now deployed to the proper environment!
- Use descriptive and obvious names.
- Don't use abbreviations, use full English words.
player
is better thanplr
. - Name things as directly as possible.
wasCalled
is better thanhasBeenCalled
.notify
is better thandoNotification
. - Name booleans as if they are yes or no questions.
isFirstRun
is better thanfirstRun
. - Name functions using verb forms:
increment
is better thanplusOne
.unzip
is better thanfilesFromZip
. - Name event handlers to express when they run.
onClick
is better thanclick
. - Put statements and expressions in positive form.
isFlying
instead ofisNotFlying
.late
intead ofnotOnTime
.- Lead with positive conditionals. Avoid
if not something then ... else ... end
.
- Don't use abbreviations, use full English words.
- If we only care about the inverse of a variable, turn it into a positive name.
missingValue
instead ofnot hasValue
.