[NPMCLI-108] Improve README prototype to make modules easier to understand Created: 23/Feb/17  Updated: 27/Feb/17  Resolved: 23/Feb/17

Status: Closed
Project: Magnolia CLI
Component/s: None
Affects Version/s: None
Fix Version/s: 2.0

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Robert Kowalski
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Sprint: Basel 84
Story Points: 1

 Description   

The readme should include some comments and more suggestions in order to guide devs to make more useful and consistant readme files.
In particular this will encourage better reuse and sharing of modules.


Generated at Mon Feb 12 04:46:36 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.