Files
goplt/docs/content/stories/phase0/0.1.3-add-gitignore-for-go-projects.md

1.5 KiB

Task 0.1.3: Add Gitignore

Metadata

  • Task ID: 0.1.3
  • Title: Add Gitignore
  • Phase: 0 - Project Setup & Foundation
  • Section: 0.1 Repository Bootstrap
  • Status: Pending
  • Priority: Medium
  • Estimated Time: 5 minutes
  • Dependencies: 0.1.1

Description

Create a comprehensive .gitignore file for Go projects that excludes build artifacts, dependencies, IDE files, and sensitive data.

Requirements

  • Ignore Go build artifacts
  • Ignore dependency caches
  • Ignore IDE-specific files
  • Ignore environment-specific files
  • Ignore secrets and sensitive data

Implementation Steps

  1. Create .gitignore in project root
  2. Add standard Go ignores:
    • *.exe, *.exe~, *.dll, *.so, *.dylib
    • *.test, *.out
    • go.work, go.work.sum
  3. Add IDE ignores:
    • .vscode/, .idea/, *.swp, *.swo
  4. Add environment ignores:
    • .env, .env.local, config/secrets/
  5. Add OS ignores:
    • .DS_Store, Thumbs.db
  6. Add build artifacts:
    • bin/, dist/, tmp/

Acceptance Criteria

  • .gitignore file exists
  • Common Go artifacts are ignored
  • IDE files are ignored
  • Sensitive files are ignored
  • Test with git status to verify

Implementation Notes

  • Use standard Go .gitignore templates
  • Ensure config/secrets/ is ignored (for secret files)
  • Consider adding *.log for log files

Testing

# Verify gitignore works
git status
# Should not show build artifacts or IDE files