docs: add README aligned to the INE README standard [DEVOPS-874]#1
Open
veilig2000 wants to merge 2 commits into
Open
docs: add README aligned to the INE README standard [DEVOPS-874]#1veilig2000 wants to merge 2 commits into
veilig2000 wants to merge 2 commits into
Conversation
Generated from codebase analysis + verified 8/8; includes the README-compliance caller [DEVOPS-1055]. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds an INE-standard README for the drf-httpsig package and introduces a lightweight caller workflow so the org-wide README compliance gate runs on pull requests (inherited “report”/“block” mode via org variable).
Changes:
- Adds a comprehensive
README.mddescribing purpose, usage, testing, and deployment details. - Adds
.github/workflows/readme-compliance.ymlto invoke the reusable README compliance workflow on PRs and manual dispatch.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | New repository README aligned to INE standard; documents auth behavior, usage, testing, CI, and deployment. |
| .github/workflows/readme-compliance.yml | Adds PR/dispatch workflow that calls the org reusable README compliance check. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment on lines
+33
to
+36
| - **On-behalf-of impersonation.** When the request carries an `On-Behalf-Of` | ||
| header, the authenticator resolves the impersonated user via a | ||
| `fetch_on_behalf_of_user(user_id)` hook (which you implement in your subclass) | ||
| and authenticates the request as that user. |
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.
Draft — README backfill (DEVOPS-1055 rollout).
Generated from local codebase analysis (generate -> adversarial-verify -> fix pipeline), style-normalized with markdownlint, and verified 8/8 against the v1.1.0 README-compliance gate. Ships with the caller stub so the gate runs in this PR (report mode — non-blocking).
readme.md, it's renamed toREADME.md(case-sensitive gate).🤖 Generated with Claude Code