Skip to content

Add contribution workflow and synopsis - #1057

Merged
Mikey Lombardi (He/Him) (michaeltlombardi) merged 6 commits into
PowerShell:mainfrom
Gijsreyn:add-contribution-workflow
Oct 14, 2026
Merged

Mikey Lombardi (He/Him) (michaeltlombardi) merged 6 commits into
PowerShell:mainfrom
Gijsreyn:add-contribution-workflow

Conversation

@Gijsreyn

@Gijsreyn Gijs Reijn (Gijsreyn) commented Aug 18, 2025 •

Copy link
Copy Markdown
Collaborator

PR Summary

For newcomers, it's helpful to understand how they can contribute and run the build.ps1 script. This pull request adds a new section to the CONTRIBUTING.md with additional steps. Also added a SYNOPSIS in the build script with examples + removed the -Verbose parameter and added the [CmdletBinding()] attribute

@michaeltlombardi

Copy link
Copy Markdown
Collaborator

Thinking about this a bit more in depth, we probably want to use this information for a contributor's guide - which would require placing the majority of the information in Markdown files in the docs folder - likely docs/contributing.

Then we could independently add documents for testing, building from source, and so on. I don't consider this a blocking concern for this PR, just something to be mindful of.

@kilasuit

Copy link
Copy Markdown

Mikey Lombardi (He/Him) (@michaeltlombardi) I like your thinking as this aligns with how the layout is in https://github.com/PowerShell/PowerShell & makes it easier to maintain docs that may be useful in other repos across across the PowerShell Org (or additional ones too) from a centralised repo in future

Kinda annoying though that as part of common repo layouts everything seems to just be thrown on the floor directly at the repo root, like a messy bedroom 😂 & that UI links to certain docs are hardcoded (atm)

Gijs Reijn (@Gijsreyn) I'd recommend as Mikey suggests and follow the PowerShell repo layout. Especially as we can then make use of features like CODEOWNERS for that whole directory easier and add an issue-template for repo documentation updates like this PR should add to the PowerShell Repo

@michaeltlombardi

Copy link
Copy Markdown
Collaborator

Gijs Reijn (@Gijsreyn) - would you mind updating this PR? I'll make an effort to get the updated version fully reviewed by next Monday (at the latest) so we can get this merged.

Copilot AI balanced review requested due to automatic review settings October 13, 2026 19:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The workflow contains an unsupported build parameter, mismatched branch names, and broken list formatting.

3 open findings
What changed in this PR

Expands contributor onboarding with a GitHub-based contribution workflow and build/test guidance.

Changes:

  • Adds repository setup, branching, testing, and pull-request steps.
  • Documents branch synchronization and build options.
File Description
CONTRIBUTING.md Adds the contributor workflow and command examples.

🧠 Review effort: Balanced


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@Gijsreyn

Copy link
Copy Markdown
Collaborator Author

Mikey Lombardi (He/Him) (@michaeltlombardi) - I have resolved the merge conflict and made a small modification with the latest changes (after 2025😄).

Merged via the queue into PowerShell:main with commit 46f104f Oct 14, 2026
1 check passed
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.

4 participants