About Issues - README [meta]

[ricmoo]

This issue a meant to just be pinned and read-only, used to introduce and explain how @ricmoo uses issues in ethers.js and will be updated from time to time.

Feel free to contact me with any questions/feedback, but issues are generally preferred as others may be wondering the same thing as you, now and in the future.

---

More info will go here soon.

Pull Requests

Pull requests are absolutely welcome, but please keep the following in mind:

• Backward compatibility within a major release is required
• Adding dependencies requires very compelling justification and must be MIT licensed
• I am aiming to keep this library lean; be mindful of bloat and keep an eye on the packages/ethers/dist/ file sizes
• Keep in mind that any new functionality has an upkeep cost; new features must work around it, testing and updates are needed to maintain it, so if a feature is overly complicated or specific, it may not make sense for me to take care of it, so maybe a companion package makes more sense
• In general, start a discussion first :)

Tags

I try to be fairly aggressive and pedantic with my use of tags, which helps keep things organized.

• discussion - Usually tasks start here and can be questions about how to use the library or documentation, or is used to further narrow down problems; often an issue is just a misunderstanding about the API or how certain aspects of Ethereum work or can be used and I need a little more context first
• investigate - Once something looks like it may be a problem, but I'm not certain it goes here; it may move back to discussion or move onto bug
• on-deck - tasks I'm likely working on right now
• bug - Eek! There is a problem...
• fixed- The bug has been fixed; often the issue will remain open for a short period to verify the OP agrees that the problem is resolved

Notes

• I will often rename an issue so that people browsing issues or others in the future looking for a solution will find it; please let me know if you feel a changed title is no longer representative of the problem

---

Links

Documentation

• Current Release (v5)
• My blog with various Ethereum techniques and ideas

Useful Queries for Issues

• Bugs that are not marked as FIXED
• Issues being currently (-ish) worked on
• Issues being actively (-ish) investigated
• Open Issues

NOTE: all issues are also periodically copied from GitHub and placed in the repository; if you have a copy of the repo locally, you have a copy of all issues, so if GitHub goes away or you are on a plane, all this valuable metadata is still at your finger tips

[ricmoo]

Useful Tips

Verify Contracts

If you are having a problem with a specific contract, you can save me (and you) a lot of time by verifying your contract on a testnet.

Often the problem is that part of your toolchain failed to update the address in an artifact file, the wrong contract is being called or the contract failed to deploy. In these cases, you will very quickly find you cannot verify the contract. :)

It's also easier for me to start debugging possible causes if I understand what is supposed to happen. Like a picture, code is worth 1024 words. :)