CLAUDE - NASA-PDS/nasa-pds.github.io GitHub Wiki

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is the GitHub Wiki repository for the NASA PDS (Planetary Data System) Engineering Node. It contains documentation, developer guides, procedures, and best practices for PDS software development. The wiki is accessible at https://github.com/NASA-PDS/nasa-pds.github.io/wiki.

Key Point: This is a documentation repository containing markdown files, not a code repository. There are no build, test, or compilation commands.

Repository Structure

All wiki pages are markdown files at the root level:

  • Home.md - Main landing page with organizational structure
  • Developer-Guides.md - Overview page linking to development guides
  • Git-and-Github-Guide.md - Comprehensive Git/GitHub workflow guide
  • Issue-Tracking.md - Issue creation, user stories, and ZenHub usage
  • Markdown-Guidelines.md - Writing standards for markdown files
  • _Footer.md - Standard footer for wiki pages with copyright

Working with This Wiki

Common Tasks

Reading wiki content:

# List all markdown files
ls -1 *.md

# Search for content across files
git grep -i "search term"

Editing wiki pages:

  • Read the file before editing
  • Follow markdown guidelines in Markdown-Guidelines.md
  • Use semantic markup (headings vs boldface)
  • Keep inline vs block elements appropriate

Committing changes:

  • Follow commit message best practices from Git-and-Github-Guide.md
  • Use imperative mood: "Update Sprint Reviews" not "Updated Sprint Reviews"
  • Start with a verb for descriptive commits
  • Wrap commit messages at 72 characters
  • Include Co-Authored-By: Claude Opus 4.6 [email protected] in commit messages

Documentation Standards

Markdown formatting:

  • Use actual heading elements (##) not boldface for headings
  • Use autolinked references for cross-references: [page-name](Page-Name)
  • Include line breaks between sections for readability
  • Emoji support available via OS keyboard shortcuts

Issue and PR references:

  • Use autolinked references: #123 for same repo, NASA-PDS/repo-name#123 for other repos
  • Link to issues, PRs, commits for traceability

PDS Engineering Node Workflow

Git workflow:

  • Follows GitHub flow (branch-based workflow)
  • Branch protection on main requires PR approval
  • Default branch: master (this wiki predates main rename)

Issue tracking:

  • User stories follow template: "As a , I can so that "
  • Issue titles should start with a verb and be user-friendly
  • Uses ZenHub for visualization across NASA-PDS organization

Pull requests:

  • PR titles should be user-friendly (used for release notes)
  • Example: "New --everyN flag for spot checking" vs "As a user, I want to..."
  • Titles become the changelog/release notes

Key Files to Reference

When making changes, reference these guides:

  • Git-and-Github-Guide.md - Git workflow, commit messages, branch protection
  • Issue-Tracking.md - Issue creation, user stories, acceptance criteria
  • Markdown-Guidelines.md - Formatting standards
  • Developer-Guides.md - Overview of all developer resources

NASA PDS Context

Repository types:

  • library - Reusable code (published to Maven, PyPI, npm)
  • micro-service - Service components (Docker images)
  • application - User-facing apps (with deployment configs)

Project management:

  • Uses ZenHub for Kanban boards
  • Sprint planning documented in Sprint-Reviews.md
  • Product backlogs organized by project area (Registry, DOI, UX, DevOps, etc.)

Important Notes

  • This wiki is public - do not include sensitive information
  • Copyright footer: California Institute of Technology, Apache License 2.0
  • All changes should maintain the public-facing, professional documentation tone
  • When referencing dates in Sprint Reviews or other docs, check existing format for consistency
⚠️ **GitHub.com Fallback** ⚠️