community
community copied to clipboard
Proposal to create a "repository practices" repo
This repository would exists to document common repository practices used across OpenTelemetry, with a couple of goals in mind:
- to help maintainers to discover new practices which are working for others and could help them as well
- to evolve these common practices over time with the input and learnings from everyone
It is NOT a goal for this repository to document or describe anything as a "best practices", because there is too much variation and nuance, and I believe the OpenTelemetry project values the independence and flexibility of individual repositories to define what is "best" for their respective communities.
Any "required" practices would continue to live in the community repository.
One reason I'm proposing "common repository practices" in its own repository (as opposed to in the community repository), is because then the repository itself can be a demonstration of various github action automations.
I started working on a similar "common repository practices" repo earlier this year while aligning across the Java repositories, and more recently worked on generalizing it more broadly. This is where it has evolved to so far: https://github.com/trask/repository-practices
My initial thought is to start with the above content, or to start with a blank repository and submit the above content section by section, but I'm very flexible with how to proceed.
It would help to know if anyone (besides me 😅) is interested in being a maintainer or approver for this new repository. I'm not expecting this to be a new SIG, or require a new meeting on the calendar, as we could probably use the weekly maintainers meeting when there are topics that would benefit from synchronous discussion.