Commit bdd7070
authored
Documentation: README Enhancements (#62)
* Documentation: README Enhancements, Repo Polish & Zero-Allocation Optimizations (#51)
This PR implements comprehensive documentation and repository enhancements as specified in issue #51. It also includes critical performance optimizations to achieve zero-allocation happy-path execution for Resilience Policies.
- **README Enhancements**: Added Mermaid diagrams for thundering herd vs. jittered retries and request lifecycle. Refactored use cases into a 'Resilience Cookbook'. Added 'Aha!' snippet and hyperscaler research branding.
- **Performance**: Achieved 0 B/op and 0 allocs/op on the happy path for pre-configured Policies. Added benchmark_test.go to verify and showcase these results.
- **Optimizations**: Implemented middleware pipeline caching and stateless execution paths to eliminate heap allocations during execution.
- **Issue Templates**: Enhanced bug report and feature request templates with structured sections.
- **Community**: Created 'good first issue' tickets for new database and cache examples.
fixes #51
* Docs: Refine README, enhance issue templates, and add benchmarks (#51)
* Docs: Restore full license section in README.md1 parent e794fa2 commit bdd7070
10 files changed
Lines changed: 353 additions & 139 deletions
File tree
- .github/ISSUE_TEMPLATE
- docs/articles
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
13 | 18 | | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
18 | 24 | | |
19 | 25 | | |
20 | 26 | | |
21 | 27 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
| 28 | + | |
| 29 | + | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
14 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
15 | 18 | | |
16 | 19 | | |
17 | 20 | | |
| |||
0 commit comments