Skip to content

Commit bdd7070

Browse files
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.md
1 parent e794fa2 commit bdd7070

10 files changed

Lines changed: 353 additions & 139 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,23 @@ assignees: ''
1010
**Describe the bug**
1111
A clear and concise description of what the bug is.
1212

13+
**Environment**
14+
- Resile Version: [e.g. v1.0.0]
15+
- Go Version: [e.g. 1.22]
16+
- OS/Arch: [e.g. Linux/amd64]
17+
1318
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. ...
16-
2. ...
17-
3. ...
19+
Steps to reproduce the behavior. A minimal, self-contained Go program is highly preferred.
20+
21+
```go
22+
// Paste your minimal reproduction code here
23+
```
1824

1925
**Expected behavior**
2026
A clear and concise description of what you expected to happen.
2127

22-
**Code Snippet**
23-
If possible, please include a minimal code example to reproduce the issue.
24-
25-
**Context**
26-
- Go version: [e.g. 1.22]
27-
- Resile version: [e.g. v1.0.0]
28-
- OS: [e.g. Linux, macOS]
28+
**Actual Behavior / Log Output**
29+
If applicable, add logs or error messages to help explain your problem.
2930

3031
**Additional context**
3132
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ assignees: ''
1010
**Is your feature request related to a problem? Please describe.**
1111
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1212

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
13+
**The "Aha!" Use Case**
14+
Describe the real-world scenario where this feature would be most useful.
15+
16+
**Proposed Implementation**
17+
A clear and concise description of how you'd like the feature to be implemented. If possible, provide a code snippet of how the API should look.
1518

1619
**Describe alternatives you've considered**
1720
A clear and concise description of any alternative solutions or features you've considered.

0 commit comments

Comments
 (0)