Skip to content

Microgame PR Guidelines

Jump to bottom
Brian Intile edited this page Oct 17, 2018 · 7 revisions

These are what I look for in each microgame pull request to determine whether I accept it (give or take). For best chances of having yours accepted, please keep these in mind.

Absolute dealbreakers

I will reject or request changes if the PR if any of these problems are present.

  • Game does not compile/run
  • Changed files outside the microgame folder (besides the folder .meta), unless there's a pre-discussed reason.
  • Script names not beginning with microgame ID
  • Empty folders (floating .metas)
  • Anything else that will Github to notice changes when Unity auto-updates (like when you save the scene). Hit ctrl+S in your scene before each commit and don't create empty folders to prevent this ever happening.
  • GameObject Instantiation on Awake()

Somewhat important stuff

I may still accept your PR if these come up but I will tell you to fix them.

  • Branch is not named properly
  • Scope of the branch is not met or is severely overshot (don't do too much at once, getting feedback is key!).
  • Speed increase does not work properly
  • Existing sound effects are not tied to timescale (unless intentional for some reason)
  • Pausing the game causes problems
  • Additional text isn't localized properly

Feedback stuff

I'll take note of these and give feedback but they likely won't be a dealbreaker for your PR.

  • Code is considerably unoptimized and could use improvements
  • Gameplay feels unintuitive or not so friendly
  • Difficulties are too difficult or too easy, either by themselves or compared to each other
  • Speed increase makes game way too hard (below speed 4-ish anyway)

Completion checklist

This is stuff I will only look at if your game is supposed to be finished when you submit it. I may either request changes to the PR or fix these myself depending on the situation, most likely the latter.

  • Total filesize goes well over 3 or 4 MB
  • Sizable unused assets in folder
  • Assets are in undesirable format (i.e. an mp3 for a song)
  • (Including sound effects are not required for your job to be complete, but implementing some placeholder sounds would be nice)
Clone this wiki locally