open-policy-agent / open-policy-agent/frameworks
Add Documentation for Error Handling
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 127
- Forks
- 61
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 13
Description
If/when clients start multiplexing requests across targets, the error handling becomes non-trivial. We should come up with some best practices and document them in the README.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README and the issue context around clients multiplexing requests across targets. Define the error-handling cases and best practices that should be covered, then document the agreed guidance in the README; completion means the multiplexed-request error behavior is clearly explained for clients.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100