potpie-project-preferences

Record and query project coding preferences via potpie graph commands.

5.6k|645|Updated Aug 12, 2024
One-click install
npx skills add https://github.com/potpie-ai/potpie --skill potpie-project-preferences
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: potpie-project-preferences
Source: https://github.com/potpie-ai/potpie/tree/main/potpie/context-engine/adapters/inbound/cli/templates/agent_bundle/.agents/skills/potpie-project-preferences
Command: npx skills add https://github.com/potpie-ai/potpie --skill potpie-project-preferences

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires potpie, and includes scripts (resource) components.

What problem does it solve?

This Skill assists in maintaining and adhering to coding conventions, preferences, and guidelines by surfacing relevant project-specific preferences at the time of code implementation or review.

Core Features & Use Cases

  • Preference Identification: Identify project preferences for error handling, file structure, frameworks, logging, etc.
  • Preference Search and Apply: Use preference search terms to apply discovered preferences in real-time.
  • Preference Recording: Record new reusable preferences in the project context for future reference.
  • Fallback Method: Utilize an MCP (Multipart Content-Type) envelope for manual usage when CLI is unavailable.
  • Use Case: For a software engineer reviewing a pull request, this skill would provide a set of established coding guidelines relevant to the project, ensuring consistency in code quality and development practices.

Quick Start

To record a coding preference for error handling, execute:

potpie --json graph catalog --task "record coding preference"
potpie graph search-entities "<scope>" --type Service --limit 10
potpie --json graph describe decisions --view preferences_for_scope --examples
potpie --json graph propose --file mutation.json
potpie --json graph commit <plan_id> --verify
potpie --json graph history --plan <plan_id>

Frequently Asked Questions about potpie-project-preferences

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I maintain coding conventions for a software project?

To maintain coding conventions, you can record and query project-specific preferences using a graph of project decisions. This surfaces established guidelines for error handling, file structure, and logging during code implementation or review.

How do I record a new coding preference for error handling?

To record a coding preference for error handling, execute potpie graph commands to search relevant entities, propose a mutation file, and commit the plan. This stores the preference in the project context for future lookup.

How can I find existing project guidelines during a pull request review?

You can find existing project guidelines by querying the graph of project decisions using preference search terms. This retrieves established coding standards relevant to the specific scope, ensuring consistency in code quality.

Do I need the potpie CLI to use project preferences?

The potpie CLI is required to execute graph commands for managing coding preferences. However, a fallback method utilizing an MCP envelope is available for manual usage when the CLI is unavailable.

What types of coding preferences can I identify for a software project?

You can identify project preferences for error handling, file structure, frameworks, and logging. These preferences are recorded as reusable context to assist developers in adhering to established coding standards.