-
Notifications
You must be signed in to change notification settings - Fork 171
Add AGENTS.md with comprehensive build and test documentation #1627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: TimHess <[email protected]>
Co-authored-by: TimHess <[email protected]>
|
@copilot review the commit history in #1571 to see the JavaScriptEncoder changes from Also, the Steeltoe Azure Container Registry allows anonymous pulls and no agent will have credentials that work with it. Update Agents.md accordingly |
…h UnicodeRanges and update AGENTS.md for Azure Container Registry Co-authored-by: TimHess <[email protected]>
Done. Changed JavaScriptEncoder from |
…code style validation section Co-authored-by: TimHess <[email protected]>
…TS.md Co-authored-by: TimHess <[email protected]>
Summary - All Code Coverage (ubuntu-latest)
|
Co-authored-by: TimHess <[email protected]>
|
@copilot add some more content for agents.md In general: For build troubleshooting: When writing tests: |
Co-authored-by: TimHess <[email protected]>
Added the requested content to AGENTS.md including:
(commit fb6b63a) |
src/Management/src/Endpoint/Actuators/RouteMappings/RouteMappingsEndpointMiddleware.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Bart Koelman <[email protected]>
- also add some more context around tests
Co-authored-by: Bart Koelman <[email protected]>
Co-authored-by: Bart Koelman <[email protected]>
…Options to ExpectedJsonSerializerOptions Co-authored-by: TimHess <[email protected]>
Co-authored-by: TimHess <[email protected]>
…opilot/add-agents-md-and-js-encoder
…rements Co-authored-by: TimHess <[email protected]>
|



Description
Resurrects documentation from closed PR #1571. Adds
AGENTS.mdto repository root with comprehensive build and test instructions for developers and CI/CD agents.AGENTS.md Contents
General Guidelines
global.jsonunless explicitly asked toNuGet.configfiles unless explicitly asked toPrerequisites and Build
dotnet buildanddotnet testcommands for quick iteration; full solution build in Release mode for final validation.github/workflows/Steeltoe.All.ymlfor detailed test procedures including environment-specific filters and test categories[FactSkippedOnPlatform]and[TheorySkippedOnPlatform]instead of trait categoriescleanupcode.ps1and.github/workflows/verify-code-style.yml)Troubleshooting
/p:TreatWarningsAsErrors=false)Based on
.github/workflows/Steeltoe.All.ymlworkflow commands.Code Changes
ManagementOptionsTest.cs- RenamedDefaultJsonSerializerOptionstoExpectedJsonSerializerOptionsto better reflect that these are the expected serializer settings that tests assert against, not the default system settingsThe JavaScriptEncoder remains configured with
UnsafeRelaxedJsonEscapinginConfigureManagementOptions.csas originally designed, which is required for the route mappings actuator to make generic method signatures human-readable (e.g., backticks in generic type names).Branch Updates
Merged latest changes from main branch, including updates to test attributes that replace
[Trait("Category", "SkipOnMacOS")]with[FactSkippedOnPlatform(nameof(OSPlatform.OSX))].Fixes #1571
Quality checklist
If your change affects other repositories, such as Documentation, Samples and/or MainSite, add linked PRs here.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.