spring-projects / spring-projects/spring-boot
Improve documentation regarding plugins inherited by the starter-parent
Open
Nobody has claimed this yet.
type: documentation
- Dominant language
- Java
- Stars
- 81.5k
- Forks
- 42.7k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 65
Description
https://twitter.com/gz_k/status/693822039984095232. In particular start-class should be better documented I think. And we also need to make more clear that the repackage goal is invoked automatically.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation covering the starter-parent and its inherited plugins. Review the references to start-class and the repackage goal, then clarify that repackage runs automatically and explain how start-class is used. The documentation is done when both behaviors are explicit to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100