Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mshima authored Jan 30, 2025
1 parent fa06640 commit d7f1169
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ khipster --build gradle --defaults --skip-install
CI samples:

```
khipster generate-sample --app-sample sample-name
khipster generate-sample
```

Tips:
Expand All @@ -54,7 +54,13 @@ Tips:

## Synchronizing generator-jhipster templates

Run:
KHipster templates are convertions of generator-jhipster templates to kotlin.
Templates of both projects are written in [EJS](https://ejs.co/#docs).

KHipster templates are placed inside spring-boot's [templates](https://github.com/jhipster/jhipster-kotlin/tree/main/generators/spring-boot/templates) folder with an hierarchy based on generator-jhipster generators.
KHipster intercepts generator-jhipster writing tasks [replacing java templates with kotlin templates](https://github.com/jhipster/jhipster-kotlin/blob/fa0664034dda3d406dc0d11bff82d4ae1150e838/generators/spring-boot/generator.js#L52-L89).

To make easier to synchronize templates we provide a synchronize dev-blueprint which will place every copy every required template:

```sh
khipster synchronize
Expand Down

0 comments on commit d7f1169

Please sign in to comment.