Home

Echoes of Tomorrow — Project Wiki

Welcome to the GitHub Wiki for the Echoes of Tomorrow project, part of GLOW Eindhoven 2025. This wiki serves as the central documentation hub for all technical aspects of the project, including setup instructions, architecture descriptions, coding guidelines, and development workflows.

---

Overview

• Project Setup
• Repository Overview
• Development Guidelines
• Branching Strategy
• Pull Request Process
• Documentation Standards
• Onboarding New Team Members

---

Project Setup

Requirements

Make sure you have the following installed:

• Git, GitHub account, and permissions to the repositories

Local Setup

git clone https://github.com/fontysdelta/echoes-master.git

---

Repository Overview

Repositories

Repository	Description
master	Python-based backend server and logic
arms	Microcontroller (C++) logic for LED control
dashboard	Web-based UI for monitoring and interaction

Each repository contains its own structure, documentation, and README.md.

---

Development Guidelines

Commit Message Format

Use the following format: <type>: <short description>

Types include:

• feat: New feature
• fix: Bug fix
• docs: Documentation update
• style: Formatting only
• refactor: Code restructuring
• test: Test-related changes
• chore: Tooling or config updates

Example: feat: add real-time microphone input handling

---

Branching Strategy

We follow the Git Flow model:

Branch	Purpose
main	Stable production-ready version
develop	Integration of all features and fixes
feature/*	New features under development
bugfix/*	Fixes for issues in develop
hotfix/*	Emergency patches to main

Direct commits to main and develop are not allowed.

---

Pull Request Process

1. Push to a feature/*, bugfix/*, or hotfix/* branch.
2. Create a pull request (PR) to develop or main.
3. Use the Pull Request Template.
4. At least one reviewer must approve.
5. Linting must pass before merging.

Pull Request Template

**Description**
What was added or changed?

**Test**
How was this tested?

**Related Task**
Which issue/task does this relate to?

---

Documentation Standards

Each repository contains:

• README.md: Installation, setup, usage
• /documentation/: Diagrams, architecture, instructions
• This Wiki: General structure, team-wide practices

---

Onboarding New Team Members

Quick Checklist

• ✅ GitHub account and repo access
• ✅ Python/Arduino/Node.js installed
• ✅ Understood branching and commit rules
• ✅ Read the README and this Wiki
• ✅ Joined team meetings (in-person or remote)

Bus Factor Awareness

Knowledge is distributed — document everything to prevent bottlenecks if one person becomes unavailable.