Skip to content

v4.1.2

Choose a tag to compare

@github-actions github-actions released this 02 Oct 07:49
· 18 commits to main since this release
0b6bdd2

Add specify! (#195)

Description

This pull request makes significant improvements to the documentation and prompt instructions for project workflows, especially around constitution management and implementation processes. The changes clarify modes of operation, add detailed step-by-step instructions, and ensure consistency and traceability across related files and workflows.

Key changes:

Constitution Management Enhancements

  • Expanded and clarified the instructions in .github/prompts/constitution.prompt.md to support both initial creation and iterative updating of the constitution, with detailed operating modes, placeholder handling, and replacement analysis for overlapping principles or rules. Added a Replacement Analysis Table, heuristics for overlap detection, and clear handling for ambiguous or destructive changes. [1] [2]
  • Improved the propagation and validation checklist for syncing changes across related templates and prompt files, using relative links and clarifying which files to update. Added explicit instructions for updating deprecated or pending sections and handling deferred actions.
  • Updated the description in .github/prompts/constitution.prompt.md to clarify the iterative nature of constitution updates.

Implementation Workflow Improvements

  • Enhanced .github/prompts/implement.prompt.md with explicit support for both local and forked repository workflows, including detection of .fork-info.json, validation of fork configuration, and branch/PR management logic. [1] [2]
  • Added detailed instructions for iterative implementation: tracking task completion state in tasks.md, skipping completed tasks, resuming from the last incomplete task, and supporting multiple runs for refinement.
  • Added comprehensive steps for automated Pull Request creation/updating, including PR title/description formatting, label management, linking to issues, and fallback GitHub CLI commands for both local and fork workflows.
  • Included steps for updating issue labels and ensuring the constitution is updated to reflect implemented changes, with clear guidance on how to keep documentation in sync with codebase state.

Documentation Consistency

  • Added a new .github/instructions/md.instructions.md file defining markdown style guidelines for consistent documentation across the repository, covering headings, lists, code blocks, links, tables, emphasis, whitespace, and more.

These changes together provide clearer, more robust, and more maintainable workflows for both constitution management and implementation, ensuring consistency and traceability across documentation and project artifacts.

  • Constitution Management Enhancements: [1] [2] [3]
  • Implementation Workflow Improvements: [1] [2] [3]
  • Documentation Consistency:

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas