Skip to content

add a README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add a README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Structured Errors for Go

Errors are great, but we need to know where they happened and why.
This library defines functions and custom error types for annotating errors with additional context.
It's like customizable stacktraces.

The primary error type, `ErrorWithContext`, attaches a stack of context messages to a base error.
When "re-throwing" an error, use `ContextualizeErrorf` or one of the `*ContextErrorf` functions
to push a message onto the context stack. Also included: convenience methods for common errors and contexts.