Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.9 KB

DEVDOCS.md

File metadata and controls

46 lines (28 loc) · 2.9 KB

RoboTutor Dev Docs

High-Level Architecture

Follow through these slides for a high-level overview of how the architecture works.

Animator Graphs

  • Look at these images to see what an animator graph looks like in state diagram form.
  • Follow along with this document to see how an entry in the queueMap is called.
  • Follow along with this document to see how to publish "features" to the animator graph.

Student Data Model

  • Here is a list of all the variables that are stored in the student model.

How XPrize Installation Process works

Follow throug these slides to see how the System Build Process works.

Documentation of individual components

  • See this doc for documentation of the WRITE component.
  • See this doc for documentation of the BubblePop component.
  • See this doc and this doc for details on how the BaseTen Math component works.

Other useful things

  • Learn a coding strategy I use to make TODO comments here.
  • Here's a list of the most common things you might need to know. Unfortunately, none of them are documented.

Developer Practices to be followed

  1. Please do not fork any repos.
  2. Instead, to add or modify a feature, create a new branch off the "development" branch:
    • git checkout development
    • git checkout -b YOUR_BRANCH_NAME development
  3. Commit your changes to your branch.
  4. Push to the RoboTutorLLC repo, but only to your branch. Then we can see your code but it won’t hurt anything else.
  5. When your code is ready for others to use, make a Pull request to the development branch so we can check your changes.
  6. Do not push to the development or master branch.