Create production-ready public repos with complete documentation, automated setup, bundled dependencies, and user-friendly installation.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Pattern for creating production-ready public repositories that others can clone and use immediately.
Creating a public repo that needs:
repo-name/
├── README.md (10-15KB, comprehensive)
├── setup.sh (automated installation)
├── LICENSE (MIT recommended)
├── CONTRIBUTING.md
├── TROUBLESHOOTING.md (20+ solutions)
├── CHECKLIST.md (20+ verification steps)
├── EXAMPLE.md (real-world workflow)
├── templates/
│ ├── template1.md
│ └── template2.md
└── bundled-dependencies/ (if applicable)
└── external-tool/
Essential sections (in order):
Example template:
# 🧠 Project Name
**One-line description highlighting key benefits.**
[](LICENSE)
## 🎯 What is This?
Brief overview (2-3 sentences).
## ✨ Features
- ⚡ **Feature 1** — description
- 🧠 **Feature 2** — description
## 🚀 Quick Start
\`\`\`bash
git clone https://github.com/user/repo.git
cd repo
./setup.sh
\`\`\`
## 📖 Manual Setup
Step-by-step instructions...
Structure:
#!/bin/bash
set -e # Exit on error
# Header
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "🎯 Project Setup"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""
# 1. Check prerequisites
echo "🔍 Checking prerequisites..."
if ! command -v tool &> /dev/null; then
echo "❌ Tool not found. Installing..."
# Install command
fi
echo "✅ Prerequisites OK"
echo ""
# 2. Get user input (interactive)
echo "📋 Configuration:"
read -p "Username: " USERNAME
read -sp "Token: " TOKEN
echo ""
echo ""
# 3. Install dependencies with fallback
echo "📦 Installing dependencies..."
if git clone --depth 1 https://github.com/external/dep.git 2>/dev/null; then
echo "✅ Installed from GitHub (latest)"
else
echo "⚠️ GitHub clone failed, using bundled copy..."
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cp -r "$SCRIPT_DIR/bundled-dep" "$INSTALL_DIR/"
echo "✅ Installed from bundle"
fi
echo ""
# 4. Configure
echo "⚙️ Configuring..."
# Configuration steps
echo "✅ Configuration complete"
echo ""
# 5. Summary
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "✅ SETUP COMPLETE!"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""
echo "📊 Summary:"
echo " • Component 1: ✅"
echo " • Component 2: ✅"
echo ""
echo "🎯 Next Steps:"
echo " 1. Step one"
echo " 2. Step two"
echo ""
Key principles:
set -e (exit on error)Problem: External repos can disappear, change, or be rate-limited.
Solution: Bundle critical dependencies with GitHub fallback.
Pattern:
# Try GitHub first (latest version)
if git clone --depth 1 https://github.com/external/tool.git 2>/dev/null; then
echo "✅ Installed from GitHub (latest)"
else
# Fallback: use bundled copy
echo "⚠️ GitHub clone failed, using bundled copy..."
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cp -r "$SCRIPT_DIR/bundled-tool" "$INSTALL_DIR/"
echo "✅ Installed from bundle"
fi
When to bundle:
When NOT to bundle:
Sections:
Format:
### **"Error message"**
**Problem:** Brief description.
**Solution:**
\`\`\`bash
# Fix command
\`\`\`
Aim for 20-30 solutions covering common issues.
Structure:
Format:
### **1. Component Installed**
\`\`\`bash
command --version
# Expected: version x.y.z
\`\`\`
- [ ] Command works
- [ ] Version displayed
Aim for 20-30 total verification steps.
Initial commit:
git add .
git commit -m "Initial commit: README, setup script, examples, license"
git push origin main
Subsequent commits:
Good commit messages:
Problem: Setup script clones from GitHub, but external repo is deleted/unavailable.
Solution: Bundle critical dependencies in repo with fallback logic.
Real example: User caught missing bundled dependency: "Woi lu lupa masukin obsidian skill?"
Problem: Script asks for confirmation at every step, slowing down installation.
User feedback: "Lo langsung buat token aja, kerjain semuannya sendiri jngn kbanyakan nanya"
Solution:
--yes flags where applicableProblem: README doesn't cover edge cases, troubleshooting, or verification.
Solution: Include:
Problem: Setup depends on external service being available.
Solution:
Problem: User doesn't know if installation succeeded.
Solution:
Problem: Appending token to ~/.bashrc without checking if it already exists → multiple runs create duplicates.
Bad:
echo "export GH_TOKEN='$GITHUB_TOKEN'" >> ~/.bashrc
# Run setup.sh 10x → 10 duplicate tokens!
Good:
# Only add if not already present
if ! grep -q "export GH_TOKEN=" ~/.bashrc 2>/dev/null; then
echo "export GH_TOKEN='$GITHUB_TOKEN'" >> ~/.bashrc
echo "✅ Token saved to ~/.bashrc"
else
# Update existing token
sed -i "s|export GH_TOKEN=.*|export GH_TOKEN='$GITHUB_TOKEN'|" ~/.bashrc
echo "✅ Token updated in ~/.bashrc"
fi
Real impact: Found in mnemosyne-obsidian repo (commit 9cfbf55).
Problem: Single-quoted heredoc (<< 'EOF') prevents variable expansion.
Bad:
cat > file.md << 'EOF'
date: $(date +%Y-%m-%d)
EOF
# Output: date: $(date +%Y-%m-%d) ← LITERAL STRING!
Good:
cat > file.md << EOF # Remove quotes!
date: $(date +%Y-%m-%d)
EOF
# Output: date: 2026-05-12 ← ACTUAL DATE!
Note: Escape backticks in content: \`command\`
Real impact: Found in mnemosyne-obsidian repo (commit 9cfbf55).
Repo: https://github.com/kevinnft/mnemosyne-obsidian
Structure:
Key features:
./setup.sh)Installation flow:
git clone https://github.com/kevinnft/mnemosyne-obsidian.git
cd mnemosyne-obsidian
./setup.sh
# Enter username + token
# Wait 5 minutes
# Done!
Before pushing to GitHub:
CRITICAL: Social media platforms use CHARACTER limits, not word limits.
Common mistake: "260 kata" (260 words) vs "260 karakter" (260 characters)
Platform limits:
Verification:
# Count characters (excluding newlines)
cat post.txt | tr -d '\n' | wc -c
Format (under 260 chars):
🧠 [Hook: problem + solution]
[Key feature 1]
[Key feature 2]
[Key feature 3]
Built on @mention1 by @mention2
[Repo URL]
#Tag1 #Tag2
Example (258 chars):
🧠 AI memory: 500x faster recall + rich notes + auto backup
Mnemosyne + Obsidian + GitHub = best of all worlds
✅ 1-cmd setup
✅ Works offline
✅ MIT license
Built on @nousresearch Hermes by @teknium
https://github.com/user/repo
#AI #Obsidian
Structure (5 threads):
Each thread: 1-2 paragraphs, code blocks where helpful, end with hashtags.
Files to create:
SOCIAL_POST_SHORT.md — Main post (under 260 chars)COMMENT_THREAD_EN.md — English explanation (5 threads)COMMENT_THREAD.md — Indonesian version (if applicable)Communication style:
Workflow preferences:
Red flags:
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
Drives development with tests. Use when implementing any logic, fixing any bug, or changing any behavior. Use when you need to prove that code works, when a bug report arrives, or when you're about to modify existing functionality.
日本語の概要は準備中です。原文の説明を表示しています。
Airtable REST API via curl. Records CRUD, filters, upserts.
日本語の概要は準備中です。原文の説明を表示しています。
Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.
日本語の概要は準備中です。原文の説明を表示しています。
Build monitoring bots that poll APIs and send notifications on state changes (new listings, price alerts, status updates)
日本語の概要は準備中です。原文の説明を表示しています。
REST/GraphQL API testing with automated validation — test endpoints, validate responses, check status codes, and ensure API contracts
日本語の概要は準備中です。原文の説明を表示しています。
Manage Apple Notes via memo CLI: create, search, edit.
日本語の概要は準備中です。原文の説明を表示しています。