Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.54 KB
Raw

Contributing to the Alchemy JS SDK

We'd love for you to contribute and help make the Alchemy SDK even better!

Issues and Feature Requests

Before you create a new issue, please search the existing issues. Otherwise, please create a new issue and fill out the issue template.

Codebase Overview

The Alchemy SDK contains multiple namespaces that encapsulate different functionality. See the README.md for a list of namespaces and their methods.

We use TypeScript to provide type safety and documentation for the SDK. Here is a brief overview of the codebase:

  • src: Contains the source code for the SDK.
  • src/index.ts: The entry point for the SDK. All developer facing classes and methods are exported here.
  • src/types: Contains the TypeScript type definitions that are used and exported by the SDK.
  • src/api: Contains the source code for exported Alchemy API namespaces and relevant classes/methods.
  • src/interal: Contains the source code for internal helpers and implementations not intended for public use.

Running Tests

To run the unit tests:

yarn test

To run the integration tests, first copy over the sample-alchemy.env file to alchemy.env and set your Alchemy API key. Then run:

yarn test-integration

Documentation

Documentation lives in the /docs and /docs-md directories. Please do not modify those directories, as the files there are automatically generated when a new version is published.