Skip to content

community_health: credit org-wide .github default files and in-tree contributing guides #7

Description

@Nayjest

community_health reads the repository's GitHub community profile, which reports only files in the repository itself. Two real-world setups get zero credit:

  1. Org-wide default community health files. GitHub applies templates from the organization's .github repository to every repo in the org. express-rate-limit keeps ISSUE_TEMPLATE/ (2 forms) and PULL_REQUEST_TEMPLATE/ in https://github.com/express-rate-limit/.github — they actively function when opening issues/PRs on express-rate-limit/express-rate-limit — yet the report scores issue_template 0/7.2 and pr_template 0/6.3. Suggested: when the repo profile lacks a file type, check the owner's .github repository (one extra contents call, cacheable per owner across a whole org's scans).

  2. Contributing guides at non-standard in-tree paths. express-rate-limit's guide lives at docs/guides/contributing.mdx (published on their docs site). GitHub only recognizes CONTRIBUTING.* in root, docs/, or .github/. The full tree is already fetched, so crediting a contributing.* basename anywhere in the tree (perhaps at partial credit, since discoverability is genuinely worse) needs no extra calls.

Raised by the maintainer in express-rate-limit/express-rate-limit#673: express-rate-limit/express-rate-limit#673 (comment)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions