Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

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

Open
janhalen opened this issue Apr 18, 2024 · 2 comments
Open

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

janhalen opened this issue Apr 18, 2024 · 2 comments
Assignees
Labels
governance template change request Issues that are related to change proposed to the goverance template

Comments

@janhalen
Copy link
Member

janhalen commented Apr 18, 2024

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 janhalen added the governance template change request Issues that are related to change proposed to the goverance template label Apr 18, 2024
@janhalen janhalen self-assigned this Apr 18, 2024
@janhalen
Copy link
Member Author

This is dependending on #27

@janhalen
Copy link
Member Author

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

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
governance template change request Issues that are related to change proposed to the goverance template
Projects
None yet
Development

No branches or pull requests

1 participant