Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.06 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.06 KB
Raw

Starswap-core

Starswap is a general purpose DEX on Starcoin.

Move Package Manager

Compile Contract

mpm package build

Run Integration Tests

mpm integration-test

Run Unit Tests

mpm package test

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Contributions in the following are welcome:

  1. Report a bug.
  2. Submit a feature request.
  3. Implement feature or fix bug.

How to add new module to starswap-core:

  1. Add New Move module to sources dir, such as MyModule.move.
  2. Write Move code and add unit test in the module file.
  3. Add an integration test to integration-tests dir, such as: test_my_module.move.
  4. Run the integration test mpm integration-test test_my_module.move .
  5. Run script ./script/build.sh for build and generate documents.