Skip to content

03. Working With Battle Team

Jani Peltonen edited this page Jan 14, 2025 · 6 revisions

⚠️ Important: Ensure you’ve completed everything in Wiki Section 1: Prerequisites and Wiki Section 2: Local Cloning Guide before proceeding to make sure you have the project setupped and ready.

How to get started with Battle Team Development.

Assets/QuantumUser folder is where most of the Battle team development happens.


👥 Mini-Teams

The Battle-Team is divided in to Mini-Teams of 1 or more members.

The members of a Mini-Team work on tasks together and need to have internal communication to make sure that everyone knows the status of your task and what to do. (each Mini-Team can independently decide how this is done in practice)

At least one member of a Mini-Team needs to attend meetings and answer for the whole Mini-Team (doesn't need to be the same person every time) but preferably all members should attend.


📆 Meetings

Full Team meetings (not just Battle-Team) (KOKO TIIMIN PALAVERI)

Battle-Team meetings (BATTLEPALAVERI)

For discussing Battle in general

Mini-Team meetings

For discussing your task with the Battle-Leads.
This means discussing

  • The status of your task
  • The implementation details
  • How to proceed

Also if your Mini-Team has not attended other meetings this meeting can be used for general information sharing.

If no one from your Mini-Team can attend this meeting then notify one of the Battle-Leads and suggest a new time and date for the meeting.

Meeting times

Check the meeting times from the shared Calendar.

Additional meeting

You can also request a meeting for additional help by sending a message in Discord with the time and date (check shared Calendar) of the meeting to the appropriate person.


📄 Basic workflow

Start a new task

  1. pull from main
  2. create your own branch based on main
  3. you are ready to start working on your task

Working on your task

  • Check if the main branch has new changes and if so, then pull the changes and then merge them to your feature branch.
  • Commit early, commit often!
  • Also remember to push to remote

Finishing your task

  1. Create a pull request
  2. Wait for someone to review your pull request before merging to main.

Branching

Primary Branch

We primarily use main branch for development.

Feature Branches

Create a feature branch for every feature you are working on. The basic structure we use for branch names in Battle-Team is, <Team>/<type>/<name>, for example Battle/feature/BallPhysics

  • Make sure you are on the main branch before creating a feature branch
    • Make sure that you choose the main branch as the base branch when using GitHub desktop

Fix Branch

Fix prefix is used for bug fixes Battle/fix/BallPhysics