Thinky Face

Thinky Face is your prompt library, finally organized. Unlimited prompt storage, full version control, fork other users' prompts, public & private sharing, MCP server, teams, and much more. Learn more.

Create Free Account

No credit card required

Creates a Change Log Entry

Joe Clarke @jclarke Updated 9 months ago Public

Prompt Files

create-changelog.md

Create a new changelog entry for Sure Send CRM.

Instructions

Phase 1: Gather Context (Automated)

Before asking the user for input, gather context from available tools:

  1. Check for GitHub CLI availability:
    bash
    gh --version 2>/dev/null

  2. If gh is available, attempt to gather PR information:
    bash
    gh pr view --json title,body,labels,headRefName 2>/dev/null

    • This may fail if there's no PR for the current branch (that's OK)
  3. Gather git information:
    ```bash

    Get current branch name

    git branch --show-current

# Get diff summary against main
git diff main --stat

# Get recent commit messages since branching from main
git log main..HEAD --oneline
```

Phase 2: Generate Suggestions

Based on the gathered context, generate suggested values:

  • Title:

    • If PR exists: Use the PR title
    • Otherwise: Derive from branch name (convert feature/add-dark-mode to "Add Dark Mode") or summarize from commit messages
  • Summary:

    • If PR exists: Use the first line/sentence of the PR body
    • Otherwise: Generate a one-line summary based on the title and commit messages
  • Details:

    • If PR exists: Use the PR body content (cleaned up for changelog format)
    • Otherwise: Generate from commit messages and diff summary

Phase 3: User Confirmation

Present the suggestions and ask the user to confirm or modify:

  1. Display suggested title and ask user to confirm or provide a different one

  2. Ask user to pick category (always ask explicitly, do not auto-select):

    • feature - New functionality (green badge)
    • improvement - Enhancements to existing features (blue badge)
    • fix - Bug fixes (yellow badge)
    • security - Security updates (red badge)
  3. Display suggested summary and ask user to confirm or provide a different one

  4. Display suggested details and ask user to confirm or provide different content

Only proceed after the user has confirmed all fields.

Phase 4: Generate Filename

Generate the filename using today's date and a slug derived from the confirmed title:
- Format: YYYY-MM-DD-slug-title.md
- Example: 2026-01-15-new-reporting-dashboard.md
- Use lowercase, hyphens instead of spaces, remove special characters

Phase 5: Create the File

Create the file in app/content/changelog/ with this structure:

---
title: "[Confirmed Title]"
date: YYYY-MM-DD
category: [confirmed category]
summary: "[Confirmed Summary]"
---

[Confirmed Details content in markdown]

Phase 6: Validate the Entry

Run validation to check for errors:
bash
rake changelog:validate

Phase 7: Generate the HTML

Generate the static HTML files:
bash
rake changelog:generate

Phase 8: Report to User

Report to the user with:
- The file path created
- Any validation errors or warnings
- Confirmation that HTML was generated
- Reminder to commit both markdown and generated HTML files

Category Definitions

  • feature - New functionality (green badge)
  • improvement - Enhancements to existing features (blue badge)
  • fix - Bug fixes (yellow badge)
  • security - Security updates (red badge)

Content Guidelines

Do:

  • Write in a conversational, human tone
  • Use simple, clear language
  • Focus on the benefit or impact to users
  • Use bullet points for lists of changes
  • Keep it concise (1-3 paragraphs is ideal)

Don't:

  • Use overly technical jargon
  • Write excessively long entries
  • Use corporate-sounding language
  • Use the word "programmatically"

Structure Examples

For features:
```markdown

What's New

Brief intro paragraph explaining the new capability.

Key Features

  • Feature 1 with benefit to users
  • Feature 2 with benefit to users

How to Use

Quick guide or link to documentation.
```

For bug fixes:
```markdown

What We Fixed

  • Description of issue and how it was resolved
  • Another fix

Thank you to everyone who reported these issues!
```

Fallback Behavior

If GitHub CLI is not available or there's no PR:
- Use git information only (branch name, commits, diff)
- Generate suggestions from available context
- Proceed with user confirmation as normal

Comments

Write a comment...

Press Enter to post

No comments yet. Be the first to comment.