Repository navigation
Add the provider-readiness rules to the ADRs - #175
Merged
Merged
Conversation
ADR-0003 forbids secrets and personal identifiers in logs, spans, error and exception messages, metadata and Exception.Data (at most the last 4 characters). ADR-0002 applies it to validators; ADR-0006 requires a display path for identifier-carrying requests and scopes "no SendAsync" to REST/JSON; ADR-0007 puts protocol auth in the provider; ADR-0010 adds a readiness checklist and the .NET casing rule for package names. The fixture rule allows only test-environment or pseudonymised data, and hand-written bodies only where the API can't produce the case. The provider form gets optional fields. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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 #109
Dated notes (pre-1.0, ADR-0001) in five ADRs, with the matching CLAUDE.md,
reviewer.md, CONTRIBUTING and skill lines:Exception.Data. At most the last 4 characters, or a template; a provider ADR may be stricter.GetValidationErrorResult(it goes into error metadata).url.path, logs, error messages andErrorResponseContext.RequestPath, and masks a 400's server message; the executor API comes with the first such provider. "NoSendAsync" is scoped to REST/JSON; SOAP and other transports follow their provider ADR.MF, notMf), the package shape is decided per provider ADR, and the skeletons aren't renamed.[]and malformed JSON in the NBP tests). The reviewer flags fixtures with real identifiers or secrets.Maintainer decisions: casing now, package shape later; at most 4 characters (a provider ADR may be stricter); API-key placement per provider ADR.
Checks
dotnet build(0 warnings); docs only, no test run. The form's YAML parses; all files LF./stop-slopand/miodkujon the new text.NBP breaks none of the new rules today: its paths and queries carry no identifiers. The deferred executor API is tracked in a follow-up issue.
🤖 Generated with Claude Code