45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
-----
|
|
|
|
Documentation: [html](https://docs-beta.ethers.io/)
|
|
|
|
-----
|
|
|
|
|
|
Contributing and Hacking
|
|
========================
|
|
|
|
|
|
The ethers.js library is something that I've written out of necessity,
|
|
and has grown somewhat organically over time.
|
|
|
|
Many things are the way they are for good (at the time, at least) reasons,
|
|
but I always welcome criticism, and am completely willing to have my mind
|
|
changed on things.
|
|
|
|
So, pull requests are always welcome, but please keep a few points in mind:
|
|
|
|
|
|
|
|
* Backwards-compatibility-breaking changes will not be accepted; they may be considered for the next major version
|
|
* Security is important; adding dependencies require fairly convincing arguments as to why
|
|
* The library aims to be lean, so keep an eye on the dist/ethers.min.js file size before and after your changes
|
|
* Add test cases for both expected and unexpected input
|
|
* Any new features need to be supported by me (future issues, documentation, testing, migration), so anything that is overly complicated or specific may not be accepted
|
|
|
|
In general, **please start an issue *before* beginning a pull request**, so we can
|
|
have a public discussion and figure out the best way to address to problem/feature.
|
|
**:)**
|
|
|
|
|
|
Building
|
|
--------
|
|
|
|
|
|
use npm run auto-build
|
|
|
|
use npm run update-version
|
|
|
|
|
|
|
|
-----
|
|
**Content Hash:** f817d13fd530f58e6a03c9b5cb7190a3b7a084e8bf6eb05b130665c36d421950 |