Contribute

The project was created during a hackathon, so we don’t yet have a complete infrastructure to make contributing smooth. BUT! There is an open issue to build such a system. In the meantime, we still try to follow Conventional Commits. Before creating a Pull Request, enable the Git hook that validates commit messages:

git config core.hooksPath .githooks
chmod +x .githooks/commit-msg

After that, your commit messages will be checked automatically.

Keep commit messages consistent

feat: add dynamic fee calculation
fix(hook): handle empty swap window
docs: improve deployment guide
test: add beforeSwap coverage

Keep things atomic

Please pay special attention to the atomicity of libraries and their tests. We want to make it as easy as possible for the open-source community to improve individual parts of the project without having to understand or modify everything else. Now read the Getting Started guide. It covers installation and how to run the project locally. Thanks for your attention and for contributing! 🎉

Overview

Code

Math

Guides

Keep commit messages consistent

Keep things atomic

​Keep commit messages consistent

​Keep things atomic

Keep commit messages consistent

Keep things atomic