Skip to content

📖 [Docs]: Contribution and PowerShell guidance made consistent#75

Merged
Marius Storhaug (MariusStorhaug) merged 6 commits into
mainfrom
docs-74-consistency-fixes
Jul 25, 2026
Merged

📖 [Docs]: Contribution and PowerShell guidance made consistent#75
Marius Storhaug (MariusStorhaug) merged 6 commits into
mainfrom
docs-74-consistency-fixes

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 25, 2026

Copy link
Copy Markdown
Member

Contributors can follow the repository, agent setup, worktree, issue-planning, and PowerShell example guidance without choosing between contradictory instructions.

Changed: Contribution guidance now agrees

  • Repository standards use the canonical pull request body sequence: summary, user-facing sections, optional technical details, then related issues last.
  • Worktree and root agent setup guidance keep concise local folder names while using the required <type>/<issue>-<slug> branch names.
  • Implementation plans organize tests alongside each behavior and explicitly preserve test-first execution.
  • PowerShell help guidance now identifies the generated psmodule.io/<Module>/Functions[/<Group>]/<Function> URL used by PSModule framework commands.

Fixed: The FunctionCount skip example follows every remaining rule

Every displayed function now includes complete comment-based help, matching [OutputType()] and .OUTPUTS metadata, typed and validated parameters, implicit output, and a .LINK to the public function's generated online reference page. Only the intentionally named FunctionCount framework test is exempted.

Technical Details

Related issues

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR aligns contributor-facing documentation so repository standards, issue planning guidance, worktree setup, and PowerShell examples no longer give conflicting instructions.

Changes:

  • Updates the PR description guidance to match the canonical PR body sequence (user-facing impact/sections first, technical details optional, related issues last).
  • Refines issue implementation-plan guidance to keep tests alongside each behavior while still enforcing test-first execution.
  • Makes Git worktree examples consistent with required branch naming (<type>/<issue>-<slug>) while keeping concise local worktree folder names, and updates the PowerShell “skip FunctionCount” example to comply with the PowerShell function standard.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/docs/Ways-of-Working/Repository-Standard.md Aligns PR description ordering guidance with the standard PR body sequence.
src/docs/Ways-of-Working/Issue-Format.md Clarifies implementation plan organization (behavior-grouped tasks; tests kept with behaviors; test-first still required).
src/docs/Ways-of-Working/Git-Worktrees.md Updates worktree layout and PowerShell commands to separate local folder names from required branch names.
src/docs/Frameworks/Process-PSModule/skipping-framework-tests.md Expands the FunctionCount skip example so every function shown meets the PowerShell function standard (help, OutputType/OUTPUTS, typing/validation, implicit output).

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2026 15:28
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as draft July 25, 2026 16:03
auto-merge was automatically disabled July 25, 2026 16:03

Pull request was converted to draft

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread src/docs/Ways-of-Working/Git-Worktrees.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread src/docs/Ways-of-Working/Git-Worktrees.md
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2026 16:14
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as draft July 25, 2026 16:31
auto-merge was automatically disabled July 25, 2026 16:31

Pull request was converted to draft

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2026 16:37
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as draft July 25, 2026 16:53
auto-merge was automatically disabled July 25, 2026 16:53

Pull request was converted to draft

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

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

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2026 16:58
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit c9162bc into main Jul 25, 2026
20 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs-74-consistency-fixes branch July 25, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reconcile contradictory contribution and PowerShell examples

2 participants