Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.5 KB

playhtml contribution guidelines

New Capabilities can-...

playhtml is designed to be a collective library of magical capabilities that anyone can attach to arbitrary HTML elements.

If you have an idea for a new capability, please first ensure that there is not a duplicate existing one in the current library (see TagType). If it doesn't exist please make a proposal for the capability you would like to add by opening an issue with the new-capability label.

To contribute your capability, you are also welcome to make a PR with your addition to elements.ts (see sample PR).


Outside of contributing new capabilities, feel free to submit any issues or PRs for bugs or improvements to the core of the library.

Contributing to the core library

There is future work I'm planning on getting to in the Issues section. If you have other ideas, please feel free to open an issue to discuss. Would love contributions from the community for any bugs or feature requests :)

Linking local packages for development

you'll need to link to local versions to test changes in common for use in playhtml or changes in playhtml for use in react. To do this, you can run the following commands:

cd packages/common
yarn link
cd ../playhtml # or other package name..
yarn link @playhtml/common