Replication Package Guide

This repository contains the public GitHub Pages guide and lightweight templates for preparing high-quality social science replication packages.

The publishable guide is in index.md. The copy button on the site embeds AGENTS.md, which contains the plain-text instructions for Codex, Claude Code, or another coding agent.

What This Repo Provides

• AGENTS.md: full agent/user instructions copied by the site button.
• assets/site.css: the custom GitHub Pages stylesheet.
• prompts/replication-package-agent.md: optional starter prompt for providing project-specific paths and constraints.
• templates/README_TEMPLATE.md: a copyable starting point for a project's one authoritative README.md.
• templates/release-readiness-report.md: structured final-report template for replication-package audits.
• templates/compact/: compact project structure for smaller replication packages.
• templates/build-analyze/: larger structure with separate build/ and analyze/ stages.
• examples/horiuchi_tago/: a completed compact package example.
• rules.dropboxignore: Dropbox-root ignore rules for R/RStudio local and session files.

Public Site

The guide is designed to publish at:

https://yhoriuchi.github.io/replication-package-guide/

The site is intentionally a single practical homepage rather than a multi-page documentation site. Keep index.md as the Pages entry point and AGENTS.md as the source copied by the primary button.

Suggested Use

Give an agent:

1. The replication package root.
2. The paper source files when available.
3. Any source-data restrictions.
4. The instructions copied from the public guide.

Require the agent to return a runnable package with master.R, per-script logs, session_info.log, one authoritative README.md, a complete figure/table crosswalk, and a readiness report.