Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (43 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.68 KB
Raw

Contribution Guide

Contributions are welcome, and any help here is appreciated. There are a few ways to take part:

  • Create an Issue - Propose a feature or report a bug.
  • Pull Request - Fix a bug or a typo, or refactor the code.
  • Improve the docs - Clear documentation helps everyone.
  • Share - Tell people about DVE, or write about how you use it.
  • Use it - Try DVE in a real project and share what you find.

Note

DVE started as the view engine inside Deserve, pulled out into its own package so the rendering layer stays small, honest about its trade-offs, and easy to reuse anywhere. That stance has not really changed. The engine stays tiny on purpose: render values, loop, branch, compose layouts, and nothing that can run arbitrary code. So if you bring a great idea but it does not fit that direction, it may not land.

Don't worry though, DVE is tested well and sharpened by the people who use it, and the goal is always the same, to keep it simple, safe, and fast across every runtime.

AI Usage Policy

You may use AI to help you contribute, but it must never waste a maintainer's time or lower the quality of the work. You are responsible for everything you submit, so read it, test it, and make sure it is correct before opening a pull request.

Prerequisites

DVE is written in TypeScript and developed on the Deno runtime, with no npm packages needed for the source, so there is no node_modules/ to install for development.

  • Deno 2.8.3 or later

The npm bundle is produced separately with unbuild, which only matters when packaging a release.

Local Development

Clone the repository and you are ready to work:

git clone git@github.com:NeaByteLab/DVE.git
cd DVE

Source lives in src/, tests in tests/, the documentation in docs/, and the editor extension in editor/.

Checks

Before opening a pull request, make sure the project formats, lints, and type checks cleanly:

deno task check

Then run the tests:

deno task test

A pull request should pass both before it is ready for review.

PRs

  • Add or update tests when behavior changes
  • Keep each pull request focused on a single change
  • Match the existing code style, the formatter and linter are the source of truth
  • Write a clear description that explains why the change is needed, not just what it does

Reporting Security Issues

Please do not report security problems through public issues. See SECURITY.md for how to report them privately.

License

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