KiGit

On-Hold LIVE View Code →

Started:

A University project for the "Software Engineering Lab" course.

Background

For the course "Software Engineering Lab" we sat together with 6 students. In a first lecture we got introduced to the course and the companies behind the projects. After this we could choose our preference for each project. At the end we got selected for one project with 5 others.

Goal

We worked together with Auto-Intern on a CLI-Tool which could help hardware developer with there KiCad projects. These projects used Git version control between schematic and pcb version. With Git it was hard to locate changes using git diff.

KiGit shows hardware developers which changes were made between versions in a simple and easy to understand way.

SCRUM

Our development was build around the agile development framework SCRUM. It focuses around short sprints after which a new iteration or increment of software should result of.

Sprints

Each sprint was 3 weeks long. Through this 3 weeks we had time to develop our software. In each sprint our team of developers (us 6 students) sat together 2 times a week to discuss who does what and how, if anyone has any trouble and if our goal for this sprint is possible or if we need to reduce our tasks to achieve the bear minimum. After each sprint we gave a team member of Auto-Intern our results so they could test them.

Sprint Review

After each sprint we met with our associate of Auto-Intern and discuessed what was good and what went wrong. We reviewed our new additions and what we were'nt been able to implement yet.

Sprint Planning

After reviewing we planned what we would do in the next sprint, what features we want to implement, what features need to be fixed and what our vision looks like for the project.

Task for University

Through the sprints we also needed to do tasks for the course itself. Task were mostly about the work behind developing a software: Doing research, drawing graphs or updating our project report.

My Part

I was mainly responsible for the parser and its underlying logic. My first approach used a parser built around predicate logic, but we eventually settled on a leaner solution using the parsing functions of GitPython and sexpdata.

Tech Stack

Code: Python

Version Control: Git

Documentation: MkDocs

Reporting: LaTex

Learning

What did I learn from this experience?

Working in a team, working with SCRUM, developing software in increments, working with a company