Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (20 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.03 KB

Contributing to DepthText

Thank you for your interest in contributing to DepthText! We welcome contributions from everyone.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install dependencies: npm install
  4. Create a branch for your feature or fix: git checkout -b my-feature
  5. Make your changes.
  6. Run the build to ensure everything works: npm run build
  7. Test the demo: Open demo/index.html in your browser.
  8. Commit your changes with a clear message.
  9. Push to your fork and submit a Pull Request.

Development

  • Source Code: The source is in src/depthtext.ts.
  • Build: We use tsup for bundling. Run npm run dev for watch mode.
  • Style: Please try to match the existing code style.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Include as much detail as possible.

License

By contributing, you agree that your contributions will be licensed under the MIT License.