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

Add documentation for error handling best practices #602

Closed
2 tasks
Tracked by #655 ...
jmcook1186 opened this issue Apr 10, 2024 · 4 comments · Fixed by #856
Closed
2 tasks
Tracked by #655 ...

Add documentation for error handling best practices #602

jmcook1186 opened this issue Apr 10, 2024 · 4 comments · Fixed by #856
Assignees
Labels
blocked The issue is blocked and cannot proceed. core-only This issue is reserved for the IF core team only
Milestone

Comments

@jmcook1186
Copy link
Contributor

jmcook1186 commented Apr 10, 2024

Sub of #655

What
Add documentation about our new error handling options

Why
As a developer I want to conform to the IF best practices for error handling when I build plugins.

Rationale
We are overhauling our error handling processes as part of our QA epic. This includes errors that surface from plugins. We will be applying the new standards to our IF maintained plugins, but we should also provide clear documentation for community developers so they can do the same if they so choose.

SoW

  • Update plugin builkder guide to explain if-core and error class protocols
  • Update builtin READMEs to explaint he errors emitted by each builtin

Size

M

@jmcook1186 jmcook1186 added this to IF Apr 10, 2024
@zanete zanete moved this to Backlog in IF Apr 22, 2024
@zanete zanete moved this from Backlog to In Design in IF Apr 22, 2024
@zanete zanete moved this from In Design to Backlog in IF Apr 23, 2024
@zanete
Copy link

zanete commented Apr 23, 2024

Blocked as we haven't decided that the best practices are yet

@zanete
Copy link

zanete commented Apr 30, 2024

Make sure you also handle timestamps and duration validation as per #466 and then create an issue per built-in plugin to confirm that they conform to the best practices

@zanete zanete modified the milestone: Improve Trust Jun 5, 2024
@zanete zanete removed the epic: QA label Jun 5, 2024
@zanete zanete added this to the Improve Trust milestone Jun 6, 2024
@zanete zanete moved this from Backlog to Blocked in IF Jun 6, 2024
@zanete
Copy link

zanete commented Jun 10, 2024

blocked by #593 and might also be covered by it, need to verify

@zanete zanete added core-only This issue is reserved for the IF core team only blocked The issue is blocked and cannot proceed. labels Jun 10, 2024
@jmcook1186 jmcook1186 moved this from Blocked to In Progress in IF Jun 19, 2024
@zanete zanete moved this from In Progress to Pending Review in IF Jun 20, 2024
@zanete
Copy link

zanete commented Jun 20, 2024

@narekhovhannisyan @manushak please take a look at the PR

@github-project-automation github-project-automation bot moved this from Pending Review to Done in IF Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked The issue is blocked and cannot proceed. core-only This issue is reserved for the IF core team only
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants