ITP3111_Healthy_O_Meter Documentation

This is the implementation of the Healthy Eating Mobile App done by:

Student	Student ID
Pang Ka Ho	2102047
Lim Ryan	2101702
Tan Zong Wei	2100642
Rachel Cha	2102803
Chew Xun Yuan	2101297

Project folder structure:

Assets
+---Art
| +---Sprites
+---Audio
| +---Music
| +---Sound
+---Builds
+---Code
| +---Scripts  # C# scripts
+---Docs       # Wiki, concept art, marketing material
+---Levels     # Anything related to game design in Unity
| +---Prefabs
| +---Scenes
| +---UI

Branches:

• main
• sprintX
• sprintX-usXX

Workflow:

1. Work on sprintX branch.
2. Branch off of sprintX branch when working on a User Story.
3. If more than one person is working on the same User Story, then share the branch.
4. When a User Story is completed, do a Pull Request and request a reviewer (anyone except the PR requester will do, just need to get another pair of eyes).
5. When the reviewer has approve the Pull Request. It is the requester's responsibility to merge and delete the unused branch.
6. Never commit broken code! Or else I will pull your ear >:(

Good git commit messages practice:

• feat: add new abilities
• fix: bug fix
• code: style/comment, no product impact
• chore: ci/cd, project structure changes
• refactor: code structure refactor
• revert: revert to previous code
• build: release #X

File and code naming conventions and standards:

• Use Pascal Case (e.g., don't use: Outofmemoryexception. use: OutOfMemoryException)
• Use descriptive names and don't abbreviate (e.g., don't use: lBtnStM. use: LargeButtonSettingsMenu)

For more information:

• Naming conventions and standards (https://www.youtube.com/watch?v=GEOqwtzmeP0)
• Recommended project folder structure (https://unity.com/how-to/organizing-your-project)