Repository navigation
Add CONTRIBUTING.md - #31
Merged
Merged
Conversation
Owner
|
Merged, thank you @IG-ABHINAV! I checked the commands, paths and test names against the repo and CI and they all match, and the translation and External Tools sections are exactly what new contributors will need. Closing #28 with this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #28.
What this adds
A short, root-level
CONTRIBUTING.mdcovering everything the issue asks for:dotnet restore,dotnet build,dotnet test TweakHub.Tests), plus the dependency-free hardware-collector checks..resxfiles live (Resources/<Domain>.<culture>.resx, domainsUI/Tweaks/Tools/Scripts/Security/Devices/Maintenance), how strings are read (L.Get,{loc:Loc}), and the rulesLocalizationTestsenforces (same keys everywhere, non-blank, matching placeholders, no untranslated English).Services/ShortcutService.csβLoadExternalTools(): unique name, approved category, exactly one ofWingetIdor HTTPSDownloadUrl, description key in all sixToolsfiles, and theShortcutServiceTestsconstraints.RiskLevelbadges, and the pinned id list inTweakCatalogueTests.Scripts/Collect-TweakHub-Hardware.cmdanddocs/hardware-reports.md(what to share and what to include).main, keep the diff focused, no generated binaries, list the commands run.Consolidation check
The repo had no
CONTRIBUTING.md,AGENTSfile or other contribution guide. The only related material is the README's Build from source, CI/CD and Hardware reports sections anddocs/hardware-reports.md; the new file links to those instead of duplicating them. Docs only β no code, no workflow changes.Commands run (all documented commands, executed)
Host: Windows Server 2022 (build 20348), .NET SDK 10.0.404.
dotnet restore TweakHub.slnTweakHub.csprojandTweakHub.Tests.csprojrestoreddotnet build TweakHub.sln -c Release --no-restoreBuild succeeded, 0 Warning(s), 0 Error(s) (26.68s)dotnet test TweakHub.Tests/TweakHub.Tests.csproj -c Release --no-build --no-restoreNo test is available β¦ TweakHub.Tests.dll. The projects targetnet10.0-windows10.0.22000.0, so the NUnit host refuses to execute below build 22000 (Only supported on Windows10.0.22000.0). CI onwindows-2022produces the same output and is green.powershell.exe -NoProfile -File Tests/HardwareCollector.Tests.ps1Hardware collector tests passed (payload syntax, tokens, hardware IDs, safe section failures).Every file link in
CONTRIBUTING.md(LICENSE,README.md#build-from-source,Scripts/Collect-TweakHub-Hardware.cmd,docs/hardware-reports.md) resolves in the repository.