Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

lukemurraynz
Copy link
Contributor

This pull request improves the clarity and readability of the docs/non-functional-requirements/reliability.md documentation 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:

  • Refined grammar, punctuation, and sentence structure across multiple sections to improve readability and clarity, including changes such as adjusting comma placement, updating phrasing for parallelism, and clarifying examples.
  • Updated the circuit breaker section to reference Microsoft’s Resilient Coding Patterns for concrete implementations of resilience patterns, alongside the Polly library.

Reliability practices and testing:

  • Improved the explanation of maintenance exercises and chaos testing, including corrections to terminology (e.g., “service meshes” instead of “services meshes”), and clarified instructions for scenario fabrication and playbook updates.
  • Enhanced the list and descriptions of chaos testing tools, and corrected references to hypothesis-driven chaos tests and related documentation.
  • Clarified recommendations for post-mortem documentation and linked it to Agile retrospectives, correcting spelling and phrasing for better guidance.

Checklist

READY TO PR? Use the check-list below to ensure your branch is ready for PR.

  • [X ] Changes follow the repo structure and land in the appropriate folder and section
  • [X ] No confidential information
  • [X ] No duplicated content
  • [X ] Labeled appropriately
  • This PR was reviewed by at least one subject matter expert
  • No lint check errors related to your changes

Note: You may see link check errors on pages you have not touched. This is normal, and due to either broken links or sites that reject link checker bots. The reviewer will help you get to a green state on these.

@Copilot Copilot AI review requested due to automatic review settings September 12, 2025 20:37
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant