notes-sync

Stage, commit, and push development notes to a Git repository.

301|17|Updated Dec 19, 2024
One-click install
npx skills add https://github.com/pgflow-dev/pgflow --skill notes-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: notes-sync
Source: https://github.com/pgflow-dev/pgflow/tree/main/.claude/skills/notes-sync
Command: npx skills add https://github.com/pgflow-dev/pgflow --skill notes-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the process of saving and synchronizing your development notes and roadmap changes to a Git repository. This ensures your valuable planning and ideation work is version-controlled, backed up, and easily shareable, without the need for manual Git commands.

Core Features & Use Cases

  • Automated Git Operations: Handles staging, committing, and pushing changes to your notes directory with minimal user input.
  • Structured Commit Messages: Guides you to use standardized commit message prefixes (e.g., Add:, Update:) for clarity and historical tracking.
  • Data Persistence: Ensures all your planning, ideas, and feature specifications are safely stored in Git, providing peace of mind.
  • Use Case: After a productive session refining ideas or updating the roadmap, simply invoke this Skill. It will prompt you for a commit message, stage all changes, commit them, and offer to push to your remote repository, keeping your planning synchronized effortlessly.

Quick Start

To commit all changes in the notes directory:

The skill will prompt for a commit message.

Example commit message: "Update: roadmap reordering"

The skill will then ask if you want to push to remote.

This skill uses 'git -C ./.notes add -A', 'git -C ./.notes commit -m "message"', and 'git -C ./.notes push'.