Establishing Project Structure: The Importance of Asset Management

Introduction

Maintaining a clean and predictable directory structure is one of the most effective ways to reduce onboarding time for new contributors. In the Greenset-Landing project, we recently focused on setting up a dedicated home for our visual assets to ensure that growth remains manageable.

The Problem

As projects scale, image and media files often end up scattered across the root directory or buried in generic folders. This leads to:

1. Difficulty in locating source files
2. Cluttered repository roots
3. Increased risk of accidental file deletion or misplacement

Without a clear convention, developers spend extra cognitive load deciding where to store new assets, which can lead to inconsistencies over time.

The Solution: Standardizing Directories

We implemented a simple, consistent directory pattern to house project images. By creating a dedicated img directory, we ensure that all media is centralized. We included a .gitkeep file to ensure the folder is tracked by version control, even when it is empty.

Think of this like organizing a physical office: instead of leaving documents on the floor, you designate a specific filing cabinet. Even if the drawer is empty when you first arrive, knowing where to put your paperwork keeps the office functional as it fills up.

/project-root
├── src/
├── img/
│   └── .gitkeep
└── package.json

This simple addition allows for a predictable path structure for all front-end assets, making it easier to reference images in the codebase without worrying about directory ambiguity.

Results

• Predictability: Every team member knows exactly where to place new visual assets.
• Clarity: The root of the repository remains uncluttered.
• Version Control: The directory structure is preserved across clones and deployments.

Getting Started

1. Audit your repository root for scattered files.
2. Create dedicated directories for assets (e.g., img, styles, data).
3. Use .gitkeep to ensure empty folders are preserved in your repository.

Key Insight

Organization is a form of technical documentation. By structuring your project folders clearly, you communicate the intended location of resources to everyone who interacts with the codebase, saving time and reducing friction.

Generated with Gitvlg.com