Skip to content

docs(security): add initial security policy #3290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

janderssonse
Copy link

@janderssonse janderssonse commented May 11, 2025

This PR adds a SECURITY.md file, battle tested in other projects and orgs, (the construct is CCO ie public domain, for example from here https://raw.githubusercontent.com/itiquette/git-provider-sync/refs/heads/main/SECURITY.md so just reuse)

A SECURITY.md would help anyone assessing the project for use, give a hint of how it handles critical no public security issues, and give anyone a clear instruction on how to report them non public.

IE, for someone thinking about using bat in an organisation or privately it would give an extra trust factor.

This policy basically says "send your findings, and we will see if we handle them, we will notify you".

Besides, being a good FOSS practice, makes the project look more professional and it is heavily supported by GitHub https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file etc as one of the community health files, so it will pop up automatically in the ui for the end user.

Examples:
Security Tab in project front will be added automatically
Skärmbild från 2025-05-11 05-57-27

Security Policy in the top right corner of UI will be added automatically

Skärmbild från 2025-05-11 05-58-05

Security Policy under Security Overview for the project will have the Security Policy green and enabled.
Skärmbild från 2025-05-11 05-58-23

NOTE: there is a <...> in the text, where the preferred channel for reporting should be added I left that for you, (or tell me what to add there, and I'll rebase with that).

NOTE: I had this in multiple orgs and projects over the years. Only once I had a report, so I dont think one should be worry about getting to much reports from this, this is at least my experience.

@janderssonse
Copy link
Author

It fails without a changelog entry, but I think this applies (I see this as docs). >[!NOTE]

For PRs, a CI workflow verifies that a suitable changelog entry is
added. If such an entry is missing, the workflow will fail. If your
changes do not need an entry to the changelog (see above), that
workflow failure can be disregarded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant