Tinkerbell Uniform Standards: Maintained Repository

[rainleander]

Our repositories should be the example from which adjacent, competing, projects look for inspiration.

Each repository should not look entirely different from other repositories in the ecosystem, having a different layout, a different testing model, or a different logging model, for example, without reason or recommendation from the subject matter experts from the community.

We should share our improvements with each ecosystem while seeking and respecting the feedback of these communities.

Whether or not strict guidelines have been provided for the project type, our repositories should ensure that the same components are offered across the board. How these components are provided may vary, based on the conventions of the project type. GitHub provides general guidance on this which they have integrated into their user experience.

Expected Behaviour

We believe this repository is Maintained and therefore needs the following files updated:

• Flagged Public
• The Maintained badge Change maintenance status in README to experimental. #139
• The Maintained Statement in the README.md Change maintenance status in README to experimental. #139
• Getting Started Tutorial
• README.md
• LICENSE
• CI/CD
• OWNERS.md Create OWNERS.md #141
• Developer Certificate of Origin
• At least two maintainers
• A Manifest File, if relevant
• Code of Conduct Create CODE_OF_CONDUCT.md #138
• How to Contribute Contributor documentation kick off #107
• SUPPORT.md Create SUPPORT.md #140
• RELEASE.md

If you feel the repository should be experimental or end of life or that you'll need assistance to update these files, please let us know by filing an issue with https://github.com/packethost/standards.

Current Behaviour

n/a

Possible Solution

n/a

Context

Packet maintains a number of public repositories that help customers to run various workloads on Packet. These repositories are in various states of completeness and quality, and being public, developers often find them and start using them. This creates problems:

• Developers using low-quality repositories may infer that Packet generally provides a low quality experience.
• Many of our repositories are put online with no formal communication with, or training for, customer success. This leads to a below average support experience when things do go wrong.
• We spend a huge amount of time supporting users through various channels when with better upfront planning, documentation and testing much of this support work could be eliminated.

To that end, we propose three tiers of repositories: Private, Experimental, and Maintained.

As a resource and example of a maintained repository, we've created https://github.com/packethost/standards. This is also where you can file any requests for assistance or modification of scope.

Your Environment

• https://github.com/tinkerbell/tinkerbell.org

[rainleander]

Closed in favour of the experimental repository #142