[NPMCLI-62] Every generated light module should contain a README Created: 17/Jan/17  Updated: 02/Feb/17  Resolved: 23/Jan/17

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

Type: Improvement Priority: Neutral
Reporter: Robert Kowalski Assignee: Robert Kowalski
Resolution: Fixed Votes: 1
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 80
Story Points: 2

 Description   

I just created a light module and realised that it does not have a README.md

The README could contain further introductions (to help the developer creating the module) and some headings (to encourage documentation, sharing and reusage), e.g.:

  • Overview
  • Installation
  • License


 Comments   
Comment by Robert Kowalski [ 18/Jan/17 ]

Thought:

If we recommend a default license people might get more encouraged to publish their light module as open source. For many developers choosing a license is hard, so this is a critical point where many people stop thinking about publishing.

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