Skip to content

Repository Cleanup and Organization #66

@fxstein

Description

@fxstein

Summary

Comprehensive cleanup and reorganization of the GoProX repository to improve maintainability, reduce size, and establish consistent standards.

Requirements

Git LFS Implementation

  • Configure Git LFS for large media files in test directory
  • Update .gitattributes to track appropriate file types
  • Migrate existing large files to LFS
  • Document LFS usage in README

Script Organization and Naming

  • Move utility scripts to dedicated directories
  • Establish consistent naming conventions for all scripts
  • Create logical grouping (e.g., firmware/, release/, maintenance/)
  • Update documentation to reflect new structure

File Header Standards

  • Establish consistent file headers across all scripts
  • Include version, author, description, and usage information
  • Create template for new scripts
  • Update existing scripts to follow standard

Repository Size Optimization

  • Remove or archive test data that exceeds GitHub limits
  • Consider external storage for large test files
  • Implement .gitignore patterns for temporary files
  • Document size management strategies

Documentation Updates

  • Update README with new repository structure
  • Document cleanup procedures
  • Add contribution guidelines
  • Update developer setup instructions

Motivation

The repository has grown significantly and needs better organization to:

  • Reduce repository size and improve clone/pull performance
  • Establish consistent standards for maintainability
  • Improve developer experience and contribution workflow
  • Ensure long-term sustainability of the project

Acceptance Criteria

  • Repository size reduced to under 1GB
  • All scripts follow consistent naming and header standards
  • Git LFS properly configured for large files
  • Documentation updated and comprehensive
  • No warnings about large files during push operations
  • Clear directory structure and organization

Reference

  • Previous cleanup work: git filter-repo operations
  • GitHub LFS documentation: https://git-lfs.github.com
  • Current repository size: ~5.1GB

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestworkflowDeveloper, testing and release related workflow

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions