Thank you for showing interest in helping out! Please, note that code and pull requests are not the only way you can contribute. You can also:
- Submit bug reports on the Issues page
- Clarify things in the README documentation
- Support development by sponsoring us 💖
Here's what you need to set up a local development environment.
- Clone the repo
git clone git@github.com:OblikStudio/kirby-link-field.git - Install npm dependencies with
npm i - Install Composer dependencies with
composer install
This repo also doubles as a test website for the plugin. Once you run composer install, you'll download Kirby. After you've started Apache, you'll be able to open the project in the browser and see a simple webpage. Then, you can navigate to http://localhost/panel and test how the link field behaves in the admin interface.
This is done with the help of index.site.php. All files related to the test site are excluded from the final package in .gitattributes.
You can run PHPUnit with composer test to see if there are any failing tests. This is done automatically in the aforementioned pre-commit hook.
Thank you! 🙏