Skip to content

Commit

Permalink
Docs: Remove .github/SECURITY.md
Browse files Browse the repository at this point in the history
One of the reasons to have this file in the xz repository was to
show vulnerability reporting info in the Security section on GitHub.
On 2024-11-25, I added SECURITY.md to the tukaani-project organization
on GitHub:

    https://github.com/tukaani-project/.github/blob/main/SECURITY.md

GitHub shows that file in all projects in the organization unless
overridden by a project-specific SECURITY.md. Thus, removing
the file from the xz repo makes GitHub show the organization-wide
text instead.

Maintaining a single copy for the whole GitHub organization makes
things simpler. It's also nicer to have fewer GitHub-specific files
in the xz repo. Information how to report bugs (including security
issues) is available in README and on the home page too.

The OpenSSF Scorecard tool didn't find .github/SECURITY.md from the
xz repository. There was a suggestion to move the file to the top-level
directory where Scorecard should find it. However, Scorecard does find
the organization-wide SECURITY.md. Thus, the file isn't needed in the
xz repository to score points in the Scorecard game:

    https://scorecard.dev/viewer/?uri=github.com/tukaani-project/xz

Closes: #148
Closes: #149
  • Loading branch information
Larhzu committed Nov 30, 2024
1 parent b361772 commit fe9e669
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions .github/SECURITY.md

This file was deleted.

0 comments on commit fe9e669

Please sign in to comment.