django-commons / django-commons/controls

Implement standard GitHub community health files using repository references

Open
#65 6 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

github-action governance
Dominant language
No language data
Stars
1
Forks
0
Avg merge
18m
Merged PRs (30d)
1

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked GitHub documentation on default community health files and review the requested CODE_OF_CONDUCT.md and SECURITY.md files. Define how central storage and references or updates would work for dependent repositories, then verify that the files remain prominent on each repository landing page.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.