Fix grammar and punctuation in reliability documentation added resilient coding patterns - #1110
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the grammar, punctuation, and readability of the reliability documentation while updating references to resilience engineering resources. The changes make the technical recommendations clearer and more actionable for developers implementing reliability practices.
Key changes:
- Enhanced grammar, punctuation, and sentence structure throughout the document for better clarity
- Updated circuit breaker section to reference Microsoft's Resilient Coding Patterns alongside Polly library
- Corrected technical terminology and improved explanations of chaos testing and maintenance practices
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Clarified the explanation of uptime and graceful failure practices.
Corrected punctuation and formatting for clarity.
Tess Ferrandez (TessFerrandez)
left a comment
There was a problem hiding this comment.
Thank you!
|
Hey team, any view on getting this approved and pushed through? Self-interested in getting this pushed, so the next time I reference the ISE Playbook in a project, it has the recommendations as a reference. |
N Youens (nyouens)
left a comment
There was a problem hiding this comment.
Sorry for the delay reviewing. lgtm and thanks
This pull request improves the clarity and readability of the
docs/non-functional-requirements/reliability.mddocumentation by refining grammar, punctuation, and sentence structure throughout, as well as updating references to resilience engineering resources. The changes help make the recommendations easier to understand and more actionable for readers.Documentation improvements:
Reliability practices and testing:
Checklist
READY TO PR? Use the check-list below to ensure your branch is ready for PR.