search

OS2offdig / governance_report_template

OS2's governance checkliste der benyttes til at belyse niveauet af et OS2 produkt.
https://os2.eu/governance
0 stars 2 forks source link

Move the template from the frontpage README to a seperate file #28

Open janhalen opened 5 months ago

janhalen commented 5 months ago

Change where the governance_template is placed.

Rationale

The README in a repo is the welcome page that explains what purpose the repos has and what digital value it delivers. While it can be argued that it is faster and simpler to access if the README instead is the template it is non-standard and irregular non expected design of a repository.

Proposed Solution

The README should be written as a welcoming, and easy to read introduction to the Governance work and have a link to the renamed template near the top and a standard "Getting Started" section that explains how to work with the template.

janhalen commented 5 months ago

This is dependending on #27

janhalen commented 5 months ago

We decided to name the template file governance_template.md and place it in the root. Make sure that it is easy to find by linking from the top of the Readme ... that is delivered in #27