Skip to main content
Version: Sprint 3

Project Methodology

Our team follows an Agile methodology, specifically adopting practices from Scrum (Schwaber & Sutherland, 2020), adapted to a lightweight, weekly-to-biweekly cadence to accommodate variable member availability across coursework. We chose this approach over a more rigid framework like Waterfall because our requirements have evolved iteratively as we've built out the editor, and Scrum's short feedback loops let us adjust task allocation and priorities each sync-up rather than committing to a fixed plan upfront.

1. Agile Framework & Communication​

  • Sprint Meetings: The project follows an iterative Agile methodology, utilizing regular sprint meetings to sync on progress.
  • Team Collaboration: Team communication and screen-sharing sessions (such as reviewing project briefs and extracting requirements) are hosted primarily on Discord.

2. Task & Issue Management​

  • Platform: Gitea is used as the central hub for tracking project milestones, issues, and overall repository management.
  • Categorization: Tasks are actively categorized using labels such as "Documentation" and "Work allocation" to keep the backlog organized.
  • Allocation: Specific issues (like editor styling, deployment, and documentation) are explicitly assigned to team members (e.g., Kauch, altairakami) to establish clear accountability.

3. Version Control & Git Strategy​

  • Branching Model: The team employs a structured branching strategy using prefixes to define the type of work being done, such as feature/ (e.g., feature/machine-parser), refact/ or refactor/ (e.g., refact/visual-editor), fix/, and build/.
  • Integration Flow: Work is not pushed directly to production; instead, branches are merged via Pull Requests into intermediate branches like dev or refact/project-structure before eventually being merged into main.
  • Continuous Integration: The repository utilizes automated CI workflows for deployment and package management tasks, such as adding pnpm installations and deployment pipelines.

4. Documentation Strategy​

  • Centralized Docs: Documentation is treated as a first-class citizen in the development roadmap, tracked via dedicated Gitea issues.
  • Tooling: The team is utilizing Docusaurus to build and maintain the project's formal documentation site.
  • Scope: Documentation deliverables include the project methodology, Git methodology, tech stack details, installation instructions, and architectural diagrams.

Evidence of Use​

Figure 1: Sprint 3 meeting 1 Figure 1: Sprint 3 meeting 1.

Figure 2: Sprint 3 meeting 2 Figure 2: Sprint 3 meeting 2.

Figure 3: Sprint 3 meeting 3 Figure 3: Sprint 3 meeting 3.

Figure 4: Sprint 3 meeting 4

Sprint 3 Retrospective Themes​

  1. Compiler and machine-model expansion: Sprint 3 code adds compiler parsing and semantic analysis, plus computational and nondeterministic machine support beyond Sprint 2's multi-variant engine and testing tools.
  2. Controlled document collaboration: The app adds email-based user search, owner-managed contributors, and an access check before a saved document enters a collaboration session.
  3. Real-time editing and persistence: Yjs synchronizes code, tests, diagram positions, and cursor awareness; durable file-version saves remain a separate operation, with a local editing fallback when sync is unavailable.

These themes describe observable implementation changes only. They do not establish that a specific decision or discussion occurred in any pictured meeting.

Reference​

Schwaber, K. & Sutherland, J. (2020). The Scrum Guide. https://scrumguides.org