Add Developing page

Foster Hangdaan 2024-11-08 08:16:20 -05:00
parent a96d65cb42
commit 822f863133
Signed by: foster
GPG key ID: E48D7F49A852F112
2 changed files with 65 additions and 0 deletions

64
Developing.md Normal file

@ -0,0 +1,64 @@
# Developing
This page provides information on how to get started with development and
## Development Setup
Ensure that the following is installed:
- [Deno](https://docs.deno.com/runtime/getting_started/installation/)
- [Git](https://git-scm.com/downloads)
Obtain the code by cloning the repo:
```shell
git clone https://code.fosterhangdaan.com/foster/lume-plugin-kroki.git
```
Change to the project directory:
```shell
cd lume-plugin-kroki
```
Now you are ready to make and [test](#testing) 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 when making changes. The `test` task is
provided as a shortcut for running the tests:
```shell
deno task test
```
## Commit Message Convention
Git commit messages should follow
[Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
### 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](#testing)— ensuring that they all pass.
[Submit a patch](/Contributing#submitting-patches) if all tests pass.

@ -2,5 +2,6 @@
### Content
- [Developing](./Developing/)
- [Contributing](./Contributing/)
- [License](./License/)