Contributing to MMI-Defi-Adapters

👍🎉 First and foremost, thank you for considering a contribution! 🎉👍

Dependencies

We aim to keep this project lightweight and prioritize fetching DeFi data directly from the standard node JSON-RPC endpoints.

We welcome issues for:

Follow the steps below to contribute changes:

Create a new branch for your work:

git checkout -b feature-or-fix-description

Implement your changes.
- Please avoid introducing new third-party APIs or libraries.
- Please save all addresses in checksum format by using getAddress(address) method from ethers
Commit your changes. Ideally, keep each change in an individual commit. Squash commits if necessary.
Before pushing, ensure your branch is up-to-date with the latest changes from /consensys-vertical-apps/mmi-defi-adapters:
```
git fetch upstream HEAD
git rebase FETCH_HEAD
```

Test your new adapter by running the scripts detailed in the README, e.g.,

npm run positions <user address> -- -p <protocol id>
npm run profits <user address> -- -p <protocol id>
npm run prices

and so on.

Before pushing, fix any linting issues by running:
```
npm run fix
```
Push your changes to your fork.
Open a pull request from within GitHub. Allow maintainer edits and populate the pull request template. If you're unsure about any sections, feel free to leave them blank or mention your uncertainty.
We may request changes. If so, add the changes to your local branch in a new commit and push them to your fork.

Thank you for your contribution!