Developing

This page provides information on how to contribute to the development of this plugin.

Development Setup

Ensure that the following are installed:

Deno
Git

Obtain the code by cloning the repo:

git clone https://code.fosterhangdaan.com/foster/lume-plugin-kroki.git

Change to the project directory:

cd lume-plugin-kroki

Now you are ready to make and test changes.

Testing

Proper plugin functionality is checked by running tests. Tests are located in the tests directory. The directory contains some basic tests, as well as a test involving a local, non-running instance of a Lume site.

It is imperative to run the tests after making changes. The test task is provided as a shortcut for running the tests:

deno task test

Commit Message Convention

Git commit messages should follow Conventional Commits 1.0.0.

Note

Only the commits to trunk are required to follow this convention.

Types

Refer to the table below for valid commit types:

Type	Description
build	Changes that affect the build system or external dependencies.
ci	Changes to our CI configuration files and scripts.
docs	Documentation only changes.
feat	A new feature.
fix	A bug fix.
perf	A code change that improves performance.
refactor	A code change that neither fixes a bug nor adds a feature.
style	Changes that do not affect the meaning of the code: white space, formatting, missing semi-colons, etc)
test	Adding missing tests or correcting existing tests.

Submitting Changes

Before submitting changes, run the tests—as described in Testing—ensuring that they all pass. Submit a patch if all tests pass.

Home

Content

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page GNU Free Documentation License.