Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 640 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 640 Bytes

CONTRIBUTING

Development

  • Run pnpm run dev to start the development toolchain
  • Run pnpm link -g to link the package globally
  • Run pnpm link -g surgio in your local surgio config repository to use the local version of surgio
  • Run generate command to check the result

Testing

  • Run pnpm run test to run the tests
  • Tests will be automatically checked by GitHub Actions
  • A green pipeline is required to merge a PR

Versioning

TODO

Documentation

  • Run pnpm run docs:dev to start the live preview of the documentation
  • Add version tag in Markdown if the feature is only available in/after a specific version