Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

[codex] Clarify plugin provider access policy#2

Merged
SeoFood merged 1 commit into
mainfrom
seofood/plugin-auth-policy-contributing
May 22, 2026
Merged

[codex] Clarify plugin provider access policy#2
SeoFood merged 1 commit into
mainfrom
seofood/plugin-auth-policy-contributing

Conversation

@SeoFood
Copy link
Copy Markdown
Contributor

@SeoFood SeoFood commented May 22, 2026

Summary

  • Adds a Provider Access Policy section to CONTRIBUTING.md.
  • Clarifies acceptable provider access paths for catalog submissions: user-provided API keys, official developer platform billing, documented third-party SDK/OAuth flows, and local-only integrations.
  • Documents disallowed access patterns such as first-party client impersonation, unsupported consumer subscription credential use, unofficial OAuth clients, copied client IDs, hidden endpoints, and token refresh flows intended for another first-party product.
  • Requires external-provider plugin READMEs to document the supported auth path.

Companion

Companion to TypeWhisper/typewhisper.com#75 for TypeWhisper/typewhisper.com#74.

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added guidelines requiring external-provider plugins to document supported authentication and access paths for user configuration
    • Introduced "Provider Access Policy" section defining acceptable third-party integration access practices and restrictions
    • Specified disallowed access behaviors including impersonation, unauthorized credentials, and off-path OAuth configurations
    • Enhanced documentation requirements for plugins to clearly specify their authentication path in README for verification

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 22, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 041e6610-a769-4c55-9d5a-7fe3246af715

📥 Commits

Reviewing files that changed from the base of the PR and between 0c13baa and ab4f71e.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

CONTRIBUTING.md is updated to establish provider access documentation requirements for external-provider plugins. A new "Provider access" checklist item requires documenting supported auth paths in README files, and a new "Provider Access Policy" section details acceptable third-party integration access patterns while explicitly prohibiting impersonation, unauthorized OAuth flows, and off-path credentials.

Changes

Provider Access Documentation Requirements

Layer / File(s) Summary
Provider access README requirement and policy
CONTRIBUTING.md
"Provider access" checklist item added to plugin README guidance requiring documentation of supported auth paths. New "Provider Access Policy" section establishes acceptable third-party integration access patterns and prohibits impersonation, unauthorized OAuth, and off-path credential usage.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly Related Issues

Poem

🐰 A guardian hops through docs so fine,
Drawing borders, marking lines.
"No tricks," it whispers, "paths must glow—
Auth that's true, not stealthy woe!"
Provider trust, now crystal clear,
Welcome, kindred developers, here.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seofood/plugin-auth-policy-contributing

Comment @coderabbitai help to get the list of available commands and usage tips.

@SeoFood SeoFood marked this pull request as ready for review May 22, 2026 16:26
@SeoFood SeoFood merged commit 10afade into main May 22, 2026
1 check was pending
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant