Contributing
If you would like to contribute to svelte materialify and improve its functionality and features or just report a bug. It is important to keep your setup to a minimum so if you can it is better to reproduce the bug in the repl playground. Before reporting an issue, ensure that: Search for a similar issues, it may have been answered. Reproduction as to be minimal and consise. If possible try running the code in the repl playground. Follow these instructions if you are planning to make a pull request. This will get the entire repository on your machine, now we can build the library. Building is done with yarn (not npm). From the root folder, install the dependencies by typing: Then to build the main library, svelte materialify itself. To build and develop the documentation site. Then you can build the API, which provides the definitions and types for the different props/events/slots for the components. First make a change and make sure it works well by running For example here Then push your changes to your github repository, finally from the github repository web page you can click the Pull Request button and a contributor will review the changes you made. Reporting Issues
Setting up Your Environment
Get the Source
$ git clone https://github.com/{your_github_user_id}/svelte-materialify.git
$ cd svelte-materialify
Build
yarn
yarn build
yarn dev
yarn api
Submit Your Change
yarn lint
and yarn test
, then commit your changes following this syntax.docs: improve contributing.md