update README.md for testing and release mvn commands

Open
#306 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Locate the README.md template or templates used by each generated project and review the existing testing and release instructions. Document mvn clean install exec:exec for normal testing and mvn clean install -Prelease for releases, then verify the generated README files contain both commands.

Written by the indexing model from the issue text.

Description

For normal testing, there is no need to build src.jar and doc.jar as well as the fat.jar as they take a lot of time. You can just run mvn clean install exec:exec to start the server. When you are planning to release, you can run mvn clean install -Prelease to build all artifacts.

The above information should be in the README.md of each generated project.

Dominant language
Java
Stars
49
Forks
25
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 networknt/light-codegen

All issues in networknt/light-codegen

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.