Skip to content

Instantly share code, notes, and snippets.

@NobleDraconian
NobleDraconian / README.md
Last active December 8, 2023 07:28
Roblox - CI for automated game deployments

Automated game deployment instructions

  1. Tag a commit in the repository with the format of v*.*.* for production releases, and a tag of v*.*.*-qa.* for QA / test releases. For example, v1.6.2-qa.3.
  2. Push the tag to origin
  3. The release.yml action should create a draft release, with the game's rbxl file automatically attached to it.
  4. Add a description to the draft release. Typically this will be release notes.
  5. Publish the release as either a full release or a pre-release.
  6. 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.
  7. Your game is now deployed to the proper environment!
@evaera
evaera / Clean Code.md
Last active July 4, 2025 14:43
Best Practices for Clean Code
  1. Use descriptive and obvious names.
    • Don't use abbreviations, use full English words. player is better than plr.
    • Name things as directly as possible. wasCalled is better than hasBeenCalled. notify is better than doNotification.
    • Name booleans as if they are yes or no questions. isFirstRun is better than firstRun.
    • Name functions using verb forms: increment is better than plusOne. unzip is better than filesFromZip.
    • Name event handlers to express when they run. onClick is better than click.
    • Put statements and expressions in positive form.
      • isFlying instead of isNotFlying. late intead of notOnTime.
      • Lead with positive conditionals. Avoid if not something then ... else ... end.
  • If we only care about the inverse of a variable, turn it into a positive name. missingValue instead of not hasValue.