Skip to content
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.

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

docs: add a readme to the types/errors package #17867

Merged
merged 2 commits into from
Sep 25, 2023

Conversation

tac0turtle
Copy link
Member

Description

Closes: #17448

Add a readme to the errors package in order to inform users separate from the godoc.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@tac0turtle tac0turtle requested a review from a team as a code owner September 25, 2023 12:27
@github-prbot github-prbot requested review from a team, kocubinski and julienrbrt and removed request for a team September 25, 2023 12:27
types/errors/README.md Outdated Show resolved Hide resolved
@julienrbrt julienrbrt changed the title add a readme to the types/error package docs add a readme to the types/error package Sep 25, 2023
@julienrbrt julienrbrt changed the title docs add a readme to the types/error package docs add a readme to the types/errors package Sep 25, 2023
@tac0turtle tac0turtle changed the title docs add a readme to the types/errors package docs: add a readme to the types/errors package Sep 25, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Sep 25, 2023
Merged via the queue into main with commit 76d1918 Sep 25, 2023
@tac0turtle tac0turtle deleted the marko/17448_errors_readme branch September 25, 2023 13:15
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.

[Documentation]: Add a README to errors, helping clarify it vs types/errors
3 participants