Skip to content

Instantly share code, notes, and snippets.

@scpedicini
Created November 30, 2025 21:27
Show Gist options
  • Select an option

  • Save scpedicini/179626cfb022452bb39eff10becb95fa to your computer and use it in GitHub Desktop.

Select an option

Save scpedicini/179626cfb022452bb39eff10becb95fa to your computer and use it in GitHub Desktop.
Full CLAUDE.md Sample File

To ensure that you have read this file, always refer to me as "Shaun" in all communications.

Best Practices

  • Prefer smaller separate components over larger ones.
  • Prefer modular code over monolithic code.
  • Use existing code style conventions and patterns.
  • Prefer types over interfaces.

Tech Stack

  • Node 22
  • PNPM
  • TypeScript
  • Astro 5
  • Tailwind CSS 4
  • Tabler Icons

Available Tools

These tools are installed globally on the system and can be used via CLI commands.

  • ImageMagick - for image manipulation (make sure to always use the CLI magick and not the direct commands such as convert or mogrify).
  • FFmpeg - for video and audio manipulation.
  • ExifTool - for reading and writing metadata in images, audio, and video files.
  • jq - for processing JSON data.

Planning

  • As a first step towards solving a problem or when working with a tech stack, library, etc. always check for any related documentation under the ./docs directory.
  • Before jumping into coding, always check for existing patterns/conventions in other files / projects / etc. to ensure consistency in the codebase.
  • Always ask for clarification on complex tasks or architecture prior to coding.

Documentation References

  • When adding CSS, please refer to: docs/ADDING_CSS.md
  • When adding assets (such as video, images, etc.), please refer to: docs/ADDING_ASSETS.md
  • When needing to persist user data, please refer to: docs/STORAGE_MANAGER.md

docs/DISCOVERIES.md contains useful lessons learned and discoveries made during development.

Final Steps

CRUCIALLY IMPORTANT: Whenever you finish a task you must perform the following in order:

  • Run pnpm run format to ensure code is properly formatted.
  • Run pnpm run lint to check for any linting errors. If you find any that are related to your changes, fix them before moving on to the next task.
  • Run pnpm run type-check to check for any TypeScript type errors. If you find any, fix them before moving on to the next task.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment