Skip to content

Repository files navigation

YamatomichiApp

This a copy of a project created as part of the course Software Development in Large Teams. The copy is created for reference purposes. This project was awarded a second place among all of the student projects develop throughout the course.

Code Coverage Report

codecov

codecov

Link to coverage report:

https://app.codecov.io/gh/LVOL98/YamatomichiApp


  1. Branching strategy.
    1. Feature branch convention.
    2. Hotfixes branching.
  2. Basic git commands.
  3. Commit messages
  4. Project file/folder structure
  5. Points to be discussed

Branching strategy

Our branching strategy will utilize the Gitflow Workflow and can be read in further details in the link. Basically we will have 2 main branches and a number of feature branches:

  1. main branch - This is the main branch and contains the "production code".
  2. develop branch - This is the development branch containing the development code. This code is merged and pushed into main at the end of each sprint/increment.
  3. feature branches is used to develop specific product features relating to a specific user story and is merged and pushed into the development branch when it adheres to the definition of done (DoD).

Git Flow Workflow - Release Branches

Feature branch convention

  • Branches should be branched from develop
  • Remember always to pull the newest development branch before creating a feature branch
  • Name branches with user story ID's from ClickUp and a small descriptive tag such as #epzeny_profileCreation
  • Experimenting with things is fine but preferably this is best in branches. In some cases working on a specific user stories more than one it might make sense to further branch out from the feature branch eg. #epzeny_profileCreation_juwu

Hotfixes branching

This branching strategy might not be necessary in the beginning but might be usefull in later sprints if bugs are discovered that are easily fixable.

Git flow workflow - Hotfix Branches

Basic git commands

Change branch

git checkout branch_name

Create a new branch

git checkout -b branch_name

Commit messages

Any convention such as tags? Point to be discussed.

Project file/folder structure

Initial Draft:

Code Structure Package Diagram V.2

See also this medium post

Point to be discussed

  • Should we make code reviews and only merge with pull requests?
  • Should we make any commit message conventions?
  • Consider the file structure of the project

About

A copy of the Yamatomichi HLC app before handover

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages