Skip to content

Commit 19982fb

Browse files
committed
improved contributing
1 parent b8e8d7e commit 19982fb

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,23 @@ Before create a pull request, please follow these instructions:
2626
- Write tests.
2727
- Run `deno fmt` to fix the code format before commit.
2828
- Document any change in the `CHANGELOG.md`.
29+
30+
## Local development
31+
32+
To use a local version of Lume in your site for testing purposes, change the
33+
`lume/` import in the import map to the local folder of Lume. For example:
34+
35+
```diff
36+
{
37+
"imports": {
38+
- "lume/": "https://deno.land/x/lume@2.5.0/",
39+
+ "lume/": "../lume/",
40+
```
41+
42+
Alternatively, use [Lume CLI](https://github.com/lumeland/cli) for a simpler
43+
process:
44+
45+
- Run `lume local --save` in your local Lume clone to set the current directory
46+
as the local Lume path.
47+
- Run `lume local` in your project folder to update the `lume/` import to the
48+
local path.

0 commit comments

Comments
 (0)