Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1.67 KB

Contributing to Datastar

Thanks for thinking about contributing to Datastar 🚀

Before You Contribute

Before you contribute, please consider that Datastar is a lightweight JavaScript framework that aims to simplify reactive web apps by using a minimalist, attribute-based approach for state management and event handling directly in HTML.

Anything outside of this scope may not be accepted. If you have a need for a feature that is not within the scope of Datastar, consider using a Web Component or writing your own Datastar plugin.

Bug Reports & Feature Requests

Before submitting bug reports and feature requests, please search the open issues and the #help channel in the Discord server to see if it has already been addressed. When submitting a new issue, please use a descriptive title and include a clear description and as much relevant information as possible.

Documentation

Datastar’s documentation is under active development. All the markdown files live in this folder. Improvements to them can be submitted via pull requests.

Pull Requests

Always open an issue to discuss your idea before submitting a pull request. Pull requests must have a descriptive title and clearly describe the problem and solution. If the pull request adds or changes behaviour, documentation and examples should be updated accordingly.

Building

Datastar comes with instructions for building, either manually or via Docker. Read the Building Guidelines »