Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Lack of documentation on templates usage with CLI tool.

Open
#121 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
cli, documentation

Research direction

Read the linked Templates explanation and CLI usage guide, then inspect the templates directory referenced by the documentation. Determine how the CLI selects or accepts templates and how users would request alternatives such as soft assertions. Done means the documentation gives a concrete, reproducible template-selection workflow.

Written by the indexing model from the issue text.

Description

Templates explanation
CLI usage guide
You can change what is generated by modifying the templates used for assertions creation (have a look at templates directory)

It's not clear at all what should I be looking at there. I see templates, but documentation gives no idea on how to change the type of assertions I want to generate. Documentation explains which template does what, and also what all these variables within templates stand for. But how do I "feed" a needed template to a CLI?
E.g., by default, classes with custom straight assertions are generated. How do I get soft assertions instead? Or some of these templates is (are?) used by CLI by default, and I need to modify it?

Dominant language
Java
Stars
72
Forks
47
PR merge metrics
No merged PRs in 30d

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.

More from assertj/assertj-generator

All issues in assertj/assertj-generator

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.