django-commons/controls

Implement standard GitHub community health files using repository references

Opened this issue · 6 comments

ryancheley commented

Background

Currently, we need a way to reference standard community files (like CODE_OF_CONDUCT.md and SECURITY.md) without duplicating them across repositories while ensuring they remain prominently visible on the repository landing page.

Problem

  • Maintaining multiple copies of community files across repositories creates maintenance overhead
  • Changes to these documents require updates in multiple places
  • We want to keep the prominent visibility GitHub provides for these files on repository landing pages

Proposed Solution

Still being investigated

Files to Include

  • CODE_OF_CONDUCT.md
  • SECURITY.md
  • Any other standard community health files we want to centralize

Acceptance Criteria

  • Community files are stored in a central location
  • Files are properly linked/referenced/updated in dependent repositories
  • Files appear prominently on repository landing pages

Resources

cunla commented

See example of what django-tailwind-cli did

oliverandrich commented

I am not sure, who gave the advice - either you, @cunla, or @tim-schilling, when I ask how to link the CoC to the project. I didn't want to replicate the official CoC, but just include a simple link to the most recent version.

cunla commented

@oliverandrich, your approach is simple and elegant!
I remember at the time we discussed having a GitHub workflow to create a PR in every repo - but honestly, your way is way simpler.
I am for having a guideline for projects to link to the standard community files in the best-practices repo and that's it.

tim-schilling commented

I go back and forth on this. For now what @oliverandrich is likely the best thing we can do. Though ideally we wouldn't require the person to click another link.

ryancheley commented

@tim-schilling why isn’t a click to another link an ideal solution? Perhaps it’s just a matter of having a written reason (i.e. good marketing) for the need for the click through?

tim-schilling commented

Oh, I guess I was just thinking that if we don't need people to do another click to get the content they are interested in, the better. And if I'm being honest, I'd like to solve the engineering problem of pushing a file down to all the repos 😅

  • 👍1