Skip to content

v4.1.4

Choose a tag to compare

View all tags
@github-actions github-actions released this 02 Oct 13:07
· 17 commits to main since this release
v4.1.4
b0c44ad
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Updating some div stuff with specify (#200)

Description

This pull request updates and clarifies the workflow instructions for planning and implementing features, with a strong focus on correct GitHub label management, improved documentation standards, and enhanced PR/release note formatting. The changes ensure that contributors follow standardized processes for labeling, documentation, and communication, making the workflow more consistent and user-friendly.

Workflow and Label Management Improvements:

  • Both .github/prompts/plan.prompt.md and .github/prompts/implement.prompt.md now require setting and updating GitHub labels (like Planning, Implementing, Specification) at the start of each workflow, with clear instructions for both forked and local repositories. Fallback gh CLI commands are provided for manual updates. [1] [2] [3] [4]
  • The implementation workflow now includes immediate label transitions (e.g., removing Planning and adding Implementing), and the planning workflow adds/removes Planning and Specification as appropriate. [1] [2]

Documentation and Formatting Standards:

  • Added a new section in .github/instructions/md.instructions.md specifying that all requirement numbers (e.g., NFR-001, FR-042) must be formatted in bold and use non-breaking hyphens to prevent line breaks and ensure consistency in all documentation.
  • .github/copilot-instructions.md now mandates that all terminal commands in documentation be prefixed with pwsh (except for GitHub MCP calls), with examples provided for clarity.

PR and Release Note Guidance:

  • The instructions for PR descriptions have been rewritten to require a user-focused, release-note style summary, with explicit sections for "What's Changed," "Usage," "Breaking Changes," and "Technical Notes." Example command-line instructions for updating PR descriptions are included.
  • The planning workflow now requires PRs to include both a version/change-level label (e.g., Major, Minor, Patch) and a phase label (Planning), with fallback CLI commands for label management. [1] [2]

Workflow Step Clarifications and Reordering:

  • Both planning and implementation prompts have been restructured and renumbered for clarity, with explicit instructions for each step, including constitution and changelog updates, commit message standards, and final PR/issue updates. [1] [2] [3]

Changelog and Constitution Updates:

  • The implementation workflow now explicitly requires updating both the constitution and the changelog with each feature or change, following best practices for documentation and release management.

These changes collectively enforce best practices for workflow automation, documentation, and communication in the repository, improving clarity and consistency for all contributors.

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
Assets 2
Loading