Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.07 KB

contributing.md

File metadata and controls

59 lines (40 loc) · 1.07 KB
Raw
title category slug parentDocSlug order hidden
Contributing
64cbb5277b5f3c0065d96616
opensea-sdk-contributions
opensea-sdk
5
false

Development Information

Setup

Before any development, install the required NPM dependencies:

npm install

And install TypeScript if you haven't already:

npm install -g typescript

Build

Then, lint and build the library into the lib directory:

npm run build

Or run the tests:

npm test

Note that the tests require access to Alchemy and the OpenSea API. The timeout is adjustable via the test script in package.json.

Testing your branch locally

npm link # in opensea-js repo
npm link opensea-js # in repo you're working on

Generate Documentation

Generate html docs, also available for browsing here:

npm run docs-build

Contributing

Contributions welcome! Please use GitHub issues for suggestions/concerns - if you prefer to express your intentions in code, feel free to submit a pull request.