Skip to content

Instantly share code, notes, and snippets.

@meleu
Last active February 6, 2019 15:59
Show Gist options
  • Save meleu/a5bb8e30f2f67626e828429e6f8ac823 to your computer and use it in GitHub Desktop.
Save meleu/a5bb8e30f2f67626e828429e6f8ac823 to your computer and use it in GitHub Desktop.
Code Review Checklist

This is a list of things that I (meleu) check when someone ask me to have their Achievement set reviewed.

Quite frequently the set is for a game that I don't know very well (or don't know at all), then I created a list of items that can be checked by using what we have available on the website, namely: Code Notes, Titles, Descriptions and achievement's logic.

Some items here are not exactly strict rules, but points that I look at and give advices when applicable.

(Special thanks to Keltron3030, televandalist and BenGhazi for suggesting more items to this list.)

Code Notes

  • Clearly written.

  • For all addresses used in logic

  • Describing appropriate values used where applicable

Achievement Logic

  • No achievements with only one condition.

  • Demo mode protection (when applicable).

  • Cheat codes protection (when applicable).

  • No redundant logic (like 0xADDRESS = 1 and ResetIf 0xADDRESS != 1).

  • Understanding the difference and the right use of PauseIf and ResetIf.

  • On a "get 100 coins" like achievement, use > 100 rather than = 100.

Achievement Design / Unwelcome Concepts

  • Achievements for "Finish level N" rather than "Reach level N+1".

  • No "two for one" achievements (like one for defeating a boss and another one for getting the dropped item).

  • No unwelcome concepts:

    • No achievements requiring glitches (acceptable in Bonus sets).

    • No achievements requiring two players.

    • No achievements requiring perfection all game (maybe acceptable in Bonus Sets).

    • No achievements for dying (simply), or playing bad without any purpose.

    • No achievements with NSFW content in text or image.

    • No achievements popping frequently with little effort from the player.

    • No achievements obtainable with zero effort for no meaningful purpose (acceptable if addressing something interesting).

    • No achievements that require excessive repetitive grinding (maybe acceptable in Bonus Sets).

    • No achievements that rely entirely on randomness, especially when there are extremely low odds.

    • No "Secret Achievements", where the players have no indication of what they're going after.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment