wtf-p 0.1.0 → 0.3.0

package/core/write-the-f-paper/references/github-contrib.md

@@ -0,0 +1,216 @@
+# WTF-P GitHub Contribution Reference
+
+This document teaches Claude how to help users contribute to the WTF-P project via GitHub.
+
+## Repository Information
+
+- **Owner**: akougkas
+- **Repo**: wtf-p
+- **URL**: https://github.com/akougkas/wtf-p
+- **Issues**: https://github.com/akougkas/wtf-p/issues
+- **PRs**: https://github.com/akougkas/wtf-p/pulls
+
+## Prerequisites Check
+
+Before any GitHub operation, verify `gh` CLI is authenticated:
+
+```bash
+gh auth status
+```
+
+If not authenticated, instruct user to run:
+```bash
+gh auth login
+```
+
+## Issue Templates
+
+### Bug Report Format
+
+```markdown
+## Bug Description
+[Clear description of what's wrong]
+
+## Steps to Reproduce
+1. [First step]
+2. [Second step]
+3. [Expected vs actual behavior]
+
+## Environment
+- WTF-P version: [run `npx wtf-p --version`]
+- Node.js version: [run `node --version`]
+- OS: [macOS/Linux/Windows]
+- Claude Code version: [if relevant]
+
+## Additional Context
+[Screenshots, logs, related issues]
+```
+
+### Feature Request Format
+
+```markdown
+## Feature Description
+[What feature do you want?]
+
+## Use Case
+[Why do you need this? What problem does it solve?]
+
+## Proposed Solution
+[How should it work? Include examples if possible]
+
+## Alternatives Considered
+[Other approaches you've thought about]
+
+## Additional Context
+[Mockups, related features, prior art]
+```
+
+## Creating Issues via `gh`
+
+### Bug Report
+```bash
+gh issue create \
+  --repo akougkas/wtf-p \
+  --title "bug: [SHORT_DESCRIPTION]" \
+  --body "$(cat <<'EOF'
+## Bug Description
+...
+
+## Steps to Reproduce
+...
+
+## Environment
+...
+EOF
+)" \
+  --label "bug"
+```
+
+### Feature Request
+```bash
+gh issue create \
+  --repo akougkas/wtf-p \
+  --title "feat: [SHORT_DESCRIPTION]" \
+  --body "$(cat <<'EOF'
+## Feature Description
+...
+
+## Use Case
+...
+EOF
+)" \
+  --label "enhancement"
+```
+
+## Pull Request Workflow
+
+### 1. Fork (if external contributor)
+```bash
+gh repo fork akougkas/wtf-p --clone
+cd wtf-p
+```
+
+### 2. Create Branch
+```bash
+git checkout -b feat/short-description
+# or
+git checkout -b fix/short-description
+```
+
+### 3. Make Changes
+Follow patterns in CONTRIBUTING.md:
+- Commands go in `commands/wtfp/`
+- Workflows go in `write-the-f-paper/workflows/`
+- Use conventional commit messages
+
+### 4. Test
+```bash
+npm test
+node bin/install.js --local
+# Test manually in Claude Code
+```
+
+### 5. Commit
+```bash
+git add .
+git commit -m "feat(commands): add new-feature command
+
+- Added X functionality
+- Updated Y for Z reason"
+```
+
+### 6. Push and Create PR
+```bash
+git push -u origin feat/short-description
+
+gh pr create \
+  --repo akougkas/wtf-p \
+  --title "feat(scope): description" \
+  --body "$(cat <<'EOF'
+## Summary
+Brief description of changes
+
+## Changes Made
+- [ ] Item 1
+- [ ] Item 2
+
+## Testing
+How to test these changes
+
+## Related Issues
+Closes #XX (if applicable)
+EOF
+)"
+```
+
+## Commit Message Convention
+
+Format: `<type>(<scope>): <description>`
+
+### Types
+| Type | Use For |
+|------|---------|
+| `feat` | New feature |
+| `fix` | Bug fix |
+| `docs` | Documentation |
+| `refactor` | Code restructuring |
+| `test` | Adding tests |
+| `chore` | Maintenance |
+
+### Scopes
+| Scope | Use For |
+|-------|---------|
+| `commands` | Slash commands |
+| `workflows` | Writing workflows |
+| `cli` | Installer scripts |
+| `templates` | LaTeX/venue templates |
+
+## Labels Reference
+
+| Label | Description |
+|-------|-------------|
+| `bug` | Something isn't working |
+| `enhancement` | New feature request |
+| `documentation` | Documentation improvements |
+| `good first issue` | Good for newcomers |
+| `help wanted` | Extra attention needed |
+
+## Common Scenarios
+
+### User found a bug while writing
+1. Gather: What command? What happened? What was expected?
+2. Check: Can we reproduce? What's the environment?
+3. Create: Issue with reproduction steps
+4. Link: Reference any error messages or logs
+
+### User wants a new command
+1. Clarify: What should it do? What's the use case?
+2. Check: Does something similar exist?
+3. Propose: Draft the command structure
+4. Create: Feature request issue or implement directly
+
+### User wants to fix something themselves
+1. Guide: Fork and clone workflow
+2. Help: Implement the fix
+3. Test: Verify it works
+4. Submit: Create PR with proper format

package/core/write-the-f-paper/templates/posters/basic.md

@@ -0,0 +1,34 @@
+---
+marp: true
+theme: uncover
+size: 4:3
+---
+
+# [Poster Title]
+
+## Authors
+Author 1, Author 2
+
+---
+
+## Introduction
+- Problem statement
+- Importance
+
+---
+
+## Methodology
+- Approach
+- Implementation details
+
+---
+
+## Results
+- Key findings
+- Charts (use ECharts!)
+
+---
+
+## Conclusion
+- Summary
+- Future work

package/core/write-the-f-paper/templates/slides/basic.md

@@ -0,0 +1,31 @@
+---
+marp: true
+theme: gaia
+_class: lead
+---
+
+# [Presentation Title]
+## [Subtitle]
+
+Author Name
+
+---
+
+# Agenda
+1. Introduction
+2. Problem Statement
+3. Methodology
+4. Results
+5. Conclusion
+
+---
+
+# Introduction
+- Context
+- High-level overview
+
+---
+
+# Conclusion
+- Final thoughts
+- Q&A

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wtf-p",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "The G.O.A.T. meta-prompting system for 10x researchers who need to submit papers and projects and proposals YESTERDAY.",
   "bin": {
     "wtfp": "bin/install.js",
@@ -8,15 +8,25 @@
     "wtf-p-uninstall": "bin/uninstall.js"
   },
   "scripts": {
-    "test": "node test/sanity.js",
+    "test": "node test/sanity.js && node test/paths.js && node test/linter.js",
+    "test:integration": "node test/integration.js",
+    "test:all": "npm test && npm run test:integration",
     "preflight": "node scripts/preflight.js",
     "release": "node scripts/release.js"
   },
   "files": [
     "bin",
-    "commands",
-    "write-the-f-paper"
+    "core",
+    "vendors"
   ],
+  "peerDependencies": {
+    "@marp-team/marp-cli": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@marp-team/marp-cli": {
+      "optional": true
+    }
+  },
   "keywords": [
     "claude",
     "claude-code",

package/vendors/claude/.claude-plugin/plugin.json

@@ -0,0 +1,12 @@
+{
+  "name": "wtf-p",
+  "description": "Academic writing toolkit - Paper, Proposal, Presentation, Poster",
+  "version": "0.3.0",
+  "author": {
+    "name": "akougkas",
+    "url": "https://github.com/akougkas"
+  },
+  "homepage": "https://github.com/akougkas/wtf-p",
+  "repository": "https://github.com/akougkas/wtf-p",
+  "license": "MIT"
+}

package/vendors/claude/commands/wtfp/contribute.md

@@ -0,0 +1,278 @@
+---
+name: wtfp:contribute
+description: Guide through contributing code to WTF-P via Pull Request
+allowed-tools:
+  - Bash
+  - Read
+  - Write
+  - Edit
+  - Glob
+  - Grep
+  - AskUserQuestion
+---
+
+<objective>
+Guide the user through the complete process of contributing code to WTF-P, from fork to Pull Request.
+</objective>
+
+<context>
+@~/.claude/write-the-f-paper/references/github-contrib.md
+@~/.claude/CONTRIBUTING.md
+</context>
+
+<process>
+
+## Step 1: Verify Prerequisites
+
+Check tools are available:
+```bash
+gh auth status 2>&1
+git --version
+node --version
+```
+
+If `gh` not authenticated:
+> Run `gh auth login` to authenticate with GitHub.
+
+## Step 2: Understand Contribution Type
+
+Use AskUserQuestion:
+
+**Question 1: What are you contributing?**
+- Header: "Type"
+- Options:
+  - "New command" - Add a /wtfp:* slash command
+  - "Bug fix" - Fix an existing issue
+  - "Workflow improvement" - Enhance a writing workflow
+  - "Documentation" - Improve docs or add examples
+  - "Other" - Something else
+
+**Question 2: Do you have an existing issue?**
+- Header: "Issue"
+- Options:
+  - "Yes, issue #___" - Link to existing issue
+  - "No, creating fresh" - New contribution without issue
+  - "I'll create one first" - Redirect to /wtfp:request-feature
+
+## Step 3: Setup Repository
+
+Check current state:
+```bash
+git remote -v
+```
+
+**If in wtf-p repo (maintainer):**
+```bash
+git checkout main
+git pull origin main
+git checkout -b [BRANCH_TYPE]/[SHORT_NAME]
+```
+
+**If not in wtf-p repo (external contributor):**
+```bash
+# Fork and clone
+gh repo fork akougkas/wtf-p --clone
+cd wtf-p
+
+# Create branch
+git checkout -b [BRANCH_TYPE]/[SHORT_NAME]
+```
+
+Branch naming:
+- `feat/add-citation-check` for features
+- `fix/install-path-spaces` for bugs
+- `docs/improve-readme` for documentation
+
+## Step 4: Guide Implementation
+
+Based on contribution type:
+
+### For New Command
+
+1. Show command template:
+```markdown
+---
+name: wtfp:command-name
+description: Brief description
+allowed-tools:
+  - Read
+  - Write
+  - AskUserQuestion
+---
+
+<objective>
+What this command accomplishes.
+</objective>
+
+<context>
+@~/.claude/write-the-f-paper/references/[relevant].md
+</context>
+
+<process>
+## Step 1: ...
+## Step 2: ...
+</process>
+```
+
+2. Create file in `commands/wtfp/[name].md`
+
+3. Follow naming conventions:
+   - `new-*` for creation
+   - `create-*` for generation
+   - `plan-*` for planning
+   - `write-*` for execution
+   - `review-*` for review
+   - `check-*` for validation
+   - `export-*` for output
+
+### For Bug Fix
+
+1. Identify the file(s) to modify
+2. Make minimal, focused changes
+3. Add test coverage if applicable
+
+### For Workflow Improvement
+
+1. Edit file in `write-the-f-paper/workflows/`
+2. If WCN version exists, update both `.md` and `.wcn.md`
+
+## Step 5: Test Changes
+
+```bash
+# Run existing tests
+npm test
+
+# Install locally for manual testing
+node bin/install.js --local --force
+
+# Test in Claude Code
+# /wtfp:your-new-command
+```
+
+Ask user to verify:
+- Does the feature work as expected?
+- Any edge cases to handle?
+- Error messages clear?
+
+## Step 6: Commit Changes
+
+Stage files:
+```bash
+git add [FILES]
+git status
+```
+
+Commit with conventional message:
+```bash
+git commit -m "[TYPE]([SCOPE]): [DESCRIPTION]
+
+[Optional body explaining why]
+
+[Closes #XX if applicable]"
+```
+
+Examples:
+- `feat(commands): add citation-check command`
+- `fix(cli): handle paths with spaces`
+- `docs(readme): clarify installation steps`
+
+## Step 7: Push and Create PR
+
+Push branch:
+```bash
+git push -u origin [BRANCH_NAME]
+```
+
+Create PR:
+```bash
+gh pr create \
+  --repo akougkas/wtf-p \
+  --title "[TYPE]([SCOPE]): [DESCRIPTION]" \
+  --body "$(cat <<'EOF'
+## Summary
+[What this PR does]
+
+## Changes
+- [Change 1]
+- [Change 2]
+
+## Testing
+- [ ] `npm test` passes
+- [ ] Manually tested in Claude Code
+- [ ] [Specific test scenario]
+
+## Related Issues
+[Closes #XX or References #XX]
+EOF
+)"
+```
+
+## Step 8: Post-PR Guidance
+
+After PR is created:
+
+1. **Show PR URL** to user
+2. **Explain review process:**
+   - Maintainer will review within a few days
+   - May request changes or ask questions
+   - Once approved, will be merged to main
+
+3. **Next steps:**
+   - Watch for review comments
+   - Respond to feedback
+   - Update PR if changes requested
+
+</process>
+
+<templates>
+
+## PR Title Format
+```
+<type>(<scope>): <description>
+```
+
+Types: feat, fix, docs, refactor, test, chore
+Scopes: commands, workflows, cli, templates
+
+## PR Body Template
+```markdown
+## Summary
+Brief description of what this PR accomplishes.
+
+## Changes
+- Added/Modified/Removed X
+- Updated Y to do Z
+
+## Testing
+How to verify this works:
+1. Install locally: `node bin/install.js --local`
+2. Run: `/wtfp:command`
+3. Expected: [outcome]
+
+## Screenshots (if UI changes)
+[Paste screenshots here]
+
+## Related Issues
+Closes #XX
+```
+
+</templates>
+
+<error-handling>
+
+**Fork already exists:** Use existing fork
+```bash
+gh repo sync [USERNAME]/wtf-p
+```
+
+**Branch already exists:**
+```bash
+git checkout [BRANCH]
+git pull origin main
+```
+
+**Push rejected:** Need to pull first or force push (with caution)
+
+**PR creation fails:** Check if branch was pushed, verify gh auth
+
+</error-handling>

package/vendors/claude/commands/wtfp/create-poster.md

@@ -0,0 +1,42 @@
+---
+name: wtfp:create-poster
+description: Full workflow for creating an academic poster from project content
+allowed-tools:
+  - Read
+  - Write
+  - Bash
+  - AskUserQuestion
+---
+
+<objective>
+Generate an academic poster based on the current project's PROJECT.md and findings.
+Uses the wtfp-marp skill to compile to HTML.
+</objective>
+
+<context>
+@~/.claude/write-the-f-paper/references/principles.md
+@~/.claude/write-the-f-paper/templates/posters/basic.md
+</context>
+
+<process>
+## Step 1: Content Synthesis
+- Read `.planning/PROJECT.md` and any drafted sections.
+- Identify key findings, methodology, and conclusion.
+
+## Step 2: User Interview
+AskUserQuestion to determine:
+- Poster title (default to project title)
+- Authors
+- Key visuals/charts needed
+- Target audience
+
+## Step 3: Markdown Generation
+- Create `poster.md` using Marp format.
+- Integrate synthesized content.
+
+## Step 4: Compilation
+- Use `wtfp-marp` skill: `npx @marp-team/marp-cli poster.md -o poster.html`
+
+## Step 5: Review
+- Present the generated poster.html path to the user.
+</process>

package/vendors/claude/commands/wtfp/create-slides.md

@@ -0,0 +1,41 @@
+---
+name: wtfp:create-slides
+description: Full workflow for creating presentation slides from project content
+allowed-tools:
+  - Read
+  - Write
+  - Bash
+  - AskUserQuestion
+---
+
+<objective>
+Generate presentation slides based on the current project's PROJECT.md and findings.
+Uses the wtfp-marp skill to compile to PDF.
+</objective>
+
+<context>
+@~/.claude/write-the-f-paper/references/principles.md
+@~/.claude/write-the-f-paper/templates/slides/
+</context>
+
+<process>
+## Step 1: Content Synthesis
+- Read `.planning/PROJECT.md` and any drafted sections.
+- Identify the core narrative and supporting claims.
+
+## Step 2: User Interview
+AskUserQuestion to determine:
+- Presentation duration/target number of slides
+- Specific focus areas
+- Audience background
+
+## Step 3: Markdown Generation
+- Create `slides.md` using Marp format.
+- Separate slides with `---`.
+
+## Step 4: Compilation
+- Use `wtfp-marp` skill: `npx @marp-team/marp-cli slides.md -o slides.pdf`
+
+## Step 5: Review
+- Present the generated slides.pdf path to the user.
+</process>