practicalli / practicalli/clojure

docs: project template design - root and custom directories

Open
#474 0 comments 0 reactions 1 assignee View on GitHub

@practicalli-johnny is already working on this.

Since May 16, 2025.

Dominant language
Makefile
Stars
117
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Describe project template design with respect to different directories in resources/template-domain/, e.g. resources/practicalli/

Existing content:
https://practical.li/clojure/clojure-cli/projects/templates/design-templates/

root

All directories and files are copies as they are into the root directory of the new project.

Use for any files that do not need template rules, e.g. the :transform in the template.edn for the project.

Custom directories

Use custom directories when rules should be applied to files and directories when copying.

  • build
  • src
  • test

src and test paths have the domain namespace added, using the top key value, e.g. [["src" "src/{{top/file}}"]] will create files under src/practicalli/

The main src and test namespace can be set using the file key value, e.g. using {{main/file}} src/practicalli/gameboard.cljandtest/practicalli/gameboard_test.clj`

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.