Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

Code Review Checklist

televandalist edited this page Jun 3, 2023 · 9 revisions

This is a list of things that code reviewers usually check when someone submits a set to be reviewed.

Code Notes

  • Clearly written. Example
  • 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

  • No 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).

Guidelines

General

Achievement Development

WIP


Portugues

Geral

Desenvolvedores


Español

General

Desarrolladores

Clone this wiki locally