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

Discuss error codes instead of just error messages #730

Closed
plocket opened this issue Jul 17, 2023 · 2 comments
Closed

Discuss error codes instead of just error messages #730

plocket opened this issue Jul 17, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@plocket
Copy link
Collaborator

plocket commented Jul 17, 2023

[Decision: After some research, we'll just use numbers sequentially as we create them.]

Might help to list all the error messages to figure out which codes might be appropriate. Shall we have numbers for types of error codes as well as the specific error itself?

Reasons: This would help us document them and then help devs find their documentation most easily whether or not the text of the error changes. [We would still include the text of the error (a short summary) along with the code.]

Edit:

Brainstorming categories of errors/warnings

Warnings:

  • Reference(?)/Missing(?) warning:
    • target var not named on page
    • target var on page not present in story table
    • Unused rows - field/variable not found in run of Story Table
    • value not found in field run of Story Table (possibly unused rows, possibly field found, but value missing)
    • file not found (in sources folder) in Story Table

Errors:

  • Syntax/parsing error: cucumber syntax/parsing errors
  • Server error: e.g.
    • server reloading (including sign out error)
    • interview not found
    • interview dependency not found (like a missing template)
  • ?? error: e.g.
    • could not pull branch during setup
    • ??
  • Reference/Value/Missing error: e.g.
    • env var not found
    • phrase not found
    • field/variable not found in linear Step
    • value not found in field in linear Step
    • file not found (in sources folder) in linear Step
  • Navigation/Submission error: e.g.
    • "infinite loop" (once we can detect that)
    • (maybe) page context doesn't exist anymore
  • Input/Incomplete error: e.g.
    • user couldn't continue (or does this go in navigation error?)
@plocket plocket added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 17, 2023
@plocket plocket self-assigned this Feb 27, 2024
@plocket
Copy link
Collaborator Author

plocket commented Apr 7, 2024

Decision: After some research, we'll just use numbers sequentially as we create them.

@plocket plocket closed this as completed Apr 7, 2024
@plocket
Copy link
Collaborator Author

plocket commented May 3, 2024

We'll also give everything codes, not just errors and warnings - error, warning, info, success, debug. That way they can all be tested appropriately and communicated about more easily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant