Initial Error Documents Structure

[JeffreyDoyle]

Initial Error Documents Structure

Background

A key part of the usability of the Flow JS-SDK will be in being able to quickly identify and remedy errors that occur during development. Since errors can naturally occur anywhere in the codebase, common errors that can come up in each of those parts of the codebase must be identified and tracked. Since common errors will likely require the same solution to fixed, those solutions to those common errors should be also tracked.

An ERRORS.md document should be created in each module to list each common error and its corresponding solution. A UID (Unique identifier) must be generated for each error and solution, and should accompany each error and solution in each ERRORS.md document.

Future work to the JS-SDK will be to implement code to catch these common errors, and throw a new error with an accompanying link to the right part of the ERRORS.md document stored in this repo. The developer receiving these errors will be able to identify which common error they are seeing, and using the UID for that error, they can find the corresponding solution to that error.

Expected Outcomes.

• An ERRORS.md document is included in each module in this repository.
• A common format is created for the ERRORS.md documents.
• A method for generating common error UIDs is identified and stored in a common README.md for reference.