robaone / source-pub

My public mono repo of all my personal projects
Apache License 2.0
0 stars 0 forks source link

Reorganize the mono repo #60

Closed robaone closed 1 year ago

robaone commented 1 year ago

Context

According to Clean Architecture, Chapter 21: Screaming Architecture, when you look at a piece of code, it should tell you what it is by the way it is structured. This repository should be structured such that it is clear that it is a collection of projects.

Change

Change the directory structure so that it is very clear that this is a collection of projects that are held together by mono repo tooling and has a set of architecture decision records and shared libraries of code.

Acceptance Criteria

References

Testing Notes

Components

Testing Steps

  1. Navigate to the git repository and look at branch feature/60-reorganize-the-mono-repo
  2. Read the README.md file and confirm that the folder structure in the repository matches
  3. Make sure that the workflow completes successfully
robaone commented 1 year ago

I would like to create a folder called projects and put project folders in that folder. This would make it clear that this is a repository with projects.

Doing some research on choices on how to format folder names. I think that I will choose to use lowercase.

Lowercase: Using all lowercase letters for project folder names is a common convention in Unix-based systems. This can make file and folder names easier to read and type, particularly if you are using the command line interface.

robaone commented 1 year ago

The folder structure matches except for the docs/adr folder. However, it is noted that the file that exists there has been published and should not be moved.

The workflow completed successfully. https://github.com/robaone/source-pub/actions/runs/4354895202

Feature testing passes