Knowledgebase

Repository Structure and Hygiene Print

  • softwareengineering, software, woocommerce, guide, howto, solution, zillionkinghost, hosting
  • 0

Keeping a repository usable.

WHAT TO CREATE FIRST

The ignore file, before the first commit.

WHY

Otherwise dependencies, build output or secrets are committed, and remain in history.

WHAT TO IGNORE

Dependencies Build output Environment files Editor and system files Logs and temporary files

WHAT TO INCLUDE AT THE ROOT

A readme A licence, where relevant Contribution guidance, where others contribute Configuration for formatting and linting

WHAT TO KEEP OUT

Large binary files.

WHY

They are stored in full for every version, and the repository grows permanently.

WHAT TO USE INSTEAD

Storage designed for large files, referenced from the repository.

WHAT TO ESTABLISH

A consistent structure A branch naming convention A commit message convention

WHAT TO REVIEW OCCASIONALLY

Repository size Stale branches Whether the ignore file still covers everything

WHAT TO DELETE

Branches merged long ago.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot