Uploaded image for project: 'Magnolia CLI'
  1. Magnolia CLI
  2. NPMCLI-62

Every generated light module should contain a README

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Neutral
    • 2.0
    • None
    • None
    • Basel 80
    • 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

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              rkowalski Robert Kowalski
              rkowalski Robert Kowalski
              Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoD