Docs: add enterprise deployment-readiness contribution guidance#14100
Open
kmishra1204 wants to merge 1 commit into
Open
Docs: add enterprise deployment-readiness contribution guidance#14100kmishra1204 wants to merge 1 commit into
kmishra1204 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor guidance for enterprise/production-oriented documentation updates by introducing a short “deployment-readiness” checklist section in CONTRIBUTING.md, helping reviewers and authors consistently cover operational concerns (security boundaries, observability, rollback).
Changes:
- Add a new “Enterprise deployment-readiness docs contributions” section to
CONTRIBUTING.md. - Provide checklist themes covering credentials/secrets boundaries, tool execution controls, observability, and rollback strategy.
- Encourage linking the motivating issue and including a realistic usage example to speed review.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| For contributors proposing production-focused agent documentation updates, include a concise readiness checklist where applicable: | ||
|
|
||
| - secret and credential boundaries |
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.
Summary
Context
Related to #14099.
Notes
Docs-only change.