Skip to content

TODO.md

Latest commit

 

History

History
157 lines (123 loc) · 4.08 KB

TODO.md

File metadata and controls

157 lines (123 loc) · 4.08 KB
Raw

TODO - Before & After Release

This file tracks tasks to complete before and after moving the plugin to a separate repository.

🔴 Critical - Must Do Before First Release

Branding & Identity

  • Replace YourVendor with actual vendor name in ALL files
    • composer.json (lines 2, 14, 28, 39, 46)
    • src/FileViewEntryPlugin.php (line 3)
    • src/FileViewEntryPluginServiceProvider.php (line 3)
    • src/Infolists/Components/FileViewEntry.php (line 3)
    • AGENTS.md (all namespace references)
    • README.md (all namespace references)
  • Update author info in composer.json
    • Name
    • Email
  • Update package name in composer.json (line 2)
    • Format: vendor/filament-file-view-entry

Repository Setup

  • Create GitHub repository
  • Add repository URL to composer.json
    • homepage
    • support.issues
    • support.source
  • Update README.md links (GitHub URLs)

Documentation

  • Add screenshots to README.md
  • Review and update AGENTS.md for accuracy

🟡 High Priority - Before Release

Testing

  • Create tests/ directory structure
  • Add Pest tests for FileViewEntry component
  • Add test for file type detection
  • Configure GitHub Actions for CI
    • PHP 8.1, 8.2, 8.3
    • Laravel 10, 11, 12
    • Filament 4

Code Quality

  • Add pint.json (Laravel Pint configuration)
  • Add .github/workflows/pint.yml (code style CI)
  • Add .github/workflows/tests.yml (test CI)
  • Run Pint and fix any style issues
  • Add .gitignore
    • vendor/
    • .phpunit.result.cache
    • composer.lock
    • .idea/
    • .vscode/

Project Files

  • Add CHANGELOG.md (follow Keep a Changelog format)
  • Add CONTRIBUTING.md (contribution guidelines)
  • Add SECURITY.md (security policy)
  • Add .editorconfig

🟢 Medium Priority - After Release

Features

  • Add support for custom icon mapping
  • Add option for list view (alternative to grid)
  • Add file size display option
  • Add bulk download option
  • Add drag-and-drop upload integration
  • Add search/filter functionality for multiple files

Enhancements

  • Add lazy loading for images in modal
  • Add keyboard navigation (arrow keys, escape)
  • Add loading states
  • Add empty state customization
  • Add support for custom blade components per file type

Documentation

  • Create video tutorial/GIF demo
  • Add more usage examples to README
  • Add FAQ section
  • Create documentation website (GitHub Pages)

🔵 Low Priority - Nice to Have

Distribution

  • Submit to Packagist
  • Add to Filament Plugin Directory (https://filamentphp.com/plugins)
    • Create plugin screenshot (2560x1440px, 16:9, JPEG)
    • Fork filamentphp.com repository
    • Create content/plugins/gheith3-file-view-entry.md
    • Add image to public/images/content/plugins/
    • Submit Pull Request
  • Create demo project repository

Community

  • Add issue templates (bug report, feature request)
  • Add pull request template
  • Set up Discord channel (optional)
  • Create social media announcement

Maintenance

  • Set up GitHub Hook for Packagist auto-update
  • Set up Dependabot for dependency updates
  • Schedule regular compatibility tests with new Filament versions

📋 Quick Commands for Setup

# After moving to separate repo, run these:

# 1. Install dependencies
composer install

# 2. Run tests
composer test

# 3. Run code style check
composer format:check

# 4. Fix code style
composer format

# 5. Tag release
git tag v1.0.0
git push origin v1.0.0

🚀 Release Checklist

  • All 🔴 Critical tasks complete (except screenshot)
  • At least 80% of 🟡 High Priority tasks complete
  • Tests passing
  • Code style clean
  • GitHub repository created
  • Package submitted to Packagist
  • Set up GitHub Hook for Packagist
  • Tag v1.0.0 pushed
  • Installation tested in fresh Laravel project

Last Updated: 2026-02-19 Plugin Version: 1.0.0-dev