Skip to content

Conversation

@MariusStorhaug
Copy link
Member

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

@MariusStorhaug MariusStorhaug self-assigned this Oct 2, 2025
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner October 2, 2025 12:56
Copilot AI review requested due to automatic review settings October 2, 2025 12:56
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request enhances the project's workflow automation by refining label management, documentation standards, and PR/release note formatting. The changes standardize processes for GitHub integration, improve consistency across workflow prompts, and establish better documentation practices.

Key changes include:

  • Improved GitHub label management with immediate transitions (Planning → Implementing)
  • Enhanced PR description formatting as release-note style content
  • New documentation standards for requirement number formatting and terminal commands

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.github/prompts/tasks.prompt.md Added requirement for task completion tracking in PR descriptions
.github/prompts/specify.prompt.md Added verification step for 'Specification' label on existing branches
.github/prompts/plan.prompt.md Restructured workflow with immediate label setting and improved PR creation process
.github/prompts/implement.prompt.md Major reorganization with label management, constitution updates, and enhanced PR description formatting
.github/instructions/md.instructions.md Added formatting standards for requirement numbers using bold and non-breaking hyphens
.github/copilot-instructions.md Added terminal command standards requiring pwsh prefix for all shell operations

@MariusStorhaug MariusStorhaug merged commit b0c44ad into main Oct 2, 2025
108 of 112 checks passed
@MariusStorhaug MariusStorhaug deleted the fixes branch October 2, 2025 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants