search

cowprotocol / cow-sdk

CoW protocol SDK
https://docs.cow.fi/cow-protocol/reference/sdks/cow-sdk
Other
31 stars 9 forks source link

Repository in-line documentation and standardisation #135

Closed mfw78 closed 1 year ago

mfw78 commented 1 year ago

This PR:

  1. Provides comprehensive typedoc annotations to all exported functions.
  2. Extracts constants used across sub-modules to the consts.ts.
  3. Removes dead code (such as transformError.ts).
  4. Standardises variable nomenclature (ie. orderUid ✅, orderId 🙅‍♂️)
  5. Modifies the Github CI/CD such that the coveralls tasks only execute if done so in the context of a repository that is configured for such (makes it nicer for those who fork to run Github actions).
  6. Use a specific commit for the openapi.yml such that the package builds are always reproducible.
mfw78 commented 1 year ago

Closed in favour of #136