Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 822 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 822 Bytes

How to contribute to zaui

Thank you for considering contributing to the zaui project!

General guidelines

  • Start small, relationships need time to grow
  • Keep PRs short
  • Large PRs should be preceded by discussions

Reporting issues

Please check for existing issues or recent fixes.
Include the following information in a new issue:

  • Minimal steps or a GitHub repo to reproduce
  • What you expected and what actually happened
  • The stacktrace if there was an exception

Working with the zaui codebase

  • Fork and clone this repo
  • Use pnpm to manage dependencies
  • Run the sveltekit dev server with pnpm dev

Tips

  • Avoid setting ZAUI_*_DIR environment variables when you run this project directly. Those are automatically set via the zaui.js CLI.