Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Docs] Standardise and Enforce readme structures #163

Closed
Ornias1993 opened this issue Feb 21, 2021 · 1 comment · Fixed by #181
Closed

[Docs] Standardise and Enforce readme structures #163

Ornias1993 opened this issue Feb 21, 2021 · 1 comment · Fixed by #181
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Ornias1993
Copy link
Member

Is your feature request related to a problem? Please describe.
For reviewers it's increasingly hard to review if everyone has their own readme.md format.
We also should stop using upstream readme.md files, because they (obviously) don't reflect our project.

Describe the solution you'd like
Standardise the readme format and rework all readme's accordingly.
Enforce if needed,

Describe alternatives you've considered
Leaving it up to individual app maintainers.
However: in some cases, such as common-chart updates, other developers than app maintainers would need to make bulk-changes or review things anyway.

@Ornias1993 Ornias1993 added enhancement New feature or request documentation Improvements or additions to documentation labels Feb 21, 2021
@Ornias1993 Ornias1993 self-assigned this Feb 23, 2021
@Ornias1993 Ornias1993 mentioned this issue Feb 23, 2021
10 tasks
@truecharts-admin
Copy link
Collaborator

This issue is locked to prevent necro-posting on closed issues. Please create a new issue or contact staff on discord of the problem persists

@truecharts truecharts locked and limited conversation to collaborators Feb 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants