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 section on "Error Codes" to CONTRIBUTING_JS.md #445

Merged
merged 4 commits into from
Nov 8, 2019

Conversation

lidel
Copy link
Member

@lidel lidel commented Nov 4, 2019

This adds section on defining and reusing Error Codes, as requested in ipfs/js-ipfs#2547 (comment)

Used Errors from interface-datastore as an example.

CONTRIBUTING_JS.md Outdated Show resolved Hide resolved
Co-Authored-By: Teri Chadbourne <terichadbourne@users.noreply.github.com>
Copy link

@jacobheun jacobheun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

License: MIT
Signed-off-by: Marcin Rataj <lidel@lidel.org>
Copy link
Member Author

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated example in 29f16bb, please take a final look, thanks!

Copy link
Member

@alanshaw alanshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I like this, might be worth saying something about the convention for codes (uppercase and starting with "ERR_") to avoid any more bikeshedding in the future :D

I also want @hugomrdias and @achingbrain's approval on this before merging so we're all aligned going forward. 🙏

CONTRIBUTING_JS.md Outdated Show resolved Hide resolved
Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to get this stuff written down :)

Co-Authored-By: Teri Chadbourne <terichadbourne@users.noreply.github.com>
@alanshaw
Copy link
Member

alanshaw commented Nov 8, 2019

Thanks everyone!

@alanshaw alanshaw merged commit a14dc0a into master Nov 8, 2019
@alanshaw alanshaw deleted the docs/add-error-codes branch November 8, 2019 15:37
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.

7 participants