Skip to content

Conversation

@Jaylyn-Barbee
Copy link
Contributor

Summary of the Pull Request

This new document serves as a handy guide, packed with key details and helpful tips to keep in mind when creating a new PowerToy.

```bash
# Module Name
Generate-FileList -fileDepsJson "" -fileListName <Module>Files -wxsFilePath $PSScriptRoot\<Module>.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\<ModuleServiceName>"
Generate-FileComponents -fileListName "<Module>Files" -wxsFilePath $PSScriptRoot\<Module>.wxs -regroot $registryroot

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

regroot is not a recognized word. (unrecognized-spelling)
```bash
# Module Name
Generate-FileList -fileDepsJson "" -fileListName <Module>Files -wxsFilePath $PSScriptRoot\<Module>.wxs -depsPath "$PSScriptRoot..\..\..\$platform\Release\<ModuleServiceName>"
Generate-FileComponents -fileListName "<Module>Files" -wxsFilePath $PSScriptRoot\<Module>.wxs -regroot $registryroot

Check failure

Code scanning / check-spelling

Unrecognized Spelling Error documentation

registryroot is not a recognized word. (unrecognized-spelling)
@github-actions

This comment has been minimized.

### Requirements

* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (Desktop & C++ workloads)
* .NET 8 SDK
Copy link
Collaborator

Choose a reason for hiding this comment

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

8 or 9? I dunno, was just wondering :).

Also, does this need to be installed manually? Wouldn't just setting up VS the right way have everything you'd need?

@github-actions

This comment has been minimized.

Copy link
Collaborator

@niels9001 niels9001 left a comment

Choose a reason for hiding this comment

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

Some nits

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@Jaylyn-Barbee Jaylyn-Barbee marked this pull request as ready for review December 17, 2025 16:36
Copy link
Collaborator

@Jay-o-Way Jay-o-Way left a comment

Choose a reason for hiding this comment

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

Couple of suggestions. Some general:

  • Keep a blank line before/after every header, list, code block et cetera. (and at end of file)
  • I would prefer to use - for lists
  • Use MD/GitHub alerts
  • A vcxproj file uses XML format


### Requirements

* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) and the following workloads/individual components:
Copy link
Collaborator

@Jay-o-Way Jay-o-Way Dec 25, 2025

Choose a reason for hiding this comment

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

VS 2022 is no longer on that page, it's VS 2026 now. But need PR #44304 first.

@Jay-o-Way
Copy link
Collaborator

Use sentence-style capitalization for headings. That means that you capitalize the first word, any proper nouns, and the first word after a colon (if there is one). Everything else is lowercase. To learn more, see Capitalization.

https://learn.microsoft.com/style-guide/scannable-content/headings

@Jaylyn-Barbee
Copy link
Contributor Author

@Jay-o-Way, I think I implemented all of your feedback! Thanks for the thorough review!

@github-actions
Copy link

github-actions bot commented Jan 6, 2026

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (3)

Gotchas
registryroot
regroot

These words are not needed and should be removed gotcha

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:Jaylyn-Barbee/PowerToys.git repository
on the jay/new-powertoys-doc branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/20752062493/attempts/1' &&
git commit -m 'Update check-spelling metadata'
Warnings ⚠️ (1)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

⚠️ Warnings Count
⚠️ ignored-expect-variant 2

See ⚠️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

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