docs: Add security policy.#281
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a repository security policy document so GitHub can surface reporting guidance under the repo’s Security tab, and so reporters have a clear disclosure path and expectations.
Changes:
- Introduces
.github/SECURITY.mddescribing supported versions, reporting channels, expected response timeline, and scope. - Documents (claimed) automated security tooling used by the repository.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| * The MicroPython firmware itself (report upstream at [micropython/micropython](https://github.com/micropython/micropython)) | ||
| * The STeaMi board hardware | ||
| * Third-party npm dependencies (report upstream to the respective package maintainers) |
There was a problem hiding this comment.
Scope currently excludes only "Third-party npm dependencies", but this repo also has third-party Python dependencies (e.g., in pyproject.toml). To avoid ambiguity, consider broadening this bullet to cover third-party dependencies in general (or explicitly mention both npm and Python tooling deps).
| * Third-party npm dependencies (report upstream to the respective package maintainers) | |
| * Third-party dependencies (e.g., npm packages, Python packages; report upstream to the respective package maintainers) |
| This repository uses: | ||
|
|
||
| * **Dependabot** for automated dependency vulnerability alerts | ||
| * **CodeQL** for static analysis on CI workflows | ||
| * **Secret scanning** for detecting leaked credentials |
There was a problem hiding this comment.
The "Automated Security" section claims CodeQL and Dependabot are in use, but there doesn't appear to be a CodeQL workflow under .github/workflows/, and there is no .github/dependabot.yml config in the repo. Either add/configure these tools or adjust the policy text to reflect what is actually enabled.
| This repository uses: | |
| * **Dependabot** for automated dependency vulnerability alerts | |
| * **CodeQL** for static analysis on CI workflows | |
| * **Secret scanning** for detecting leaked credentials | |
| This repository currently relies on: | |
| * **Secret scanning** for detecting leaked credentials | |
| Additional automated security tooling (such as CodeQL or Dependabot) may be added in the future as part of ongoing security improvements. |
| | latest release | Yes | | ||
| | older releases | No | | ||
|
|
||
| Only the latest release on the `main` branch receives security updates. |
There was a problem hiding this comment.
The sentence "Only the latest release on the main branch" is confusing/inaccurate wording because releases are tags (not on a branch). Consider rephrasing to something like "Only the most recent tagged release is supported" (or, if intended, "Only the main branch is supported").
| Only the latest release on the `main` branch receives security updates. | |
| Only the most recent tagged release receives security updates. |
|
Les trois remarques de Copilot ont été corrigées dans cdcee53 :
|
Summary
Add
.github/SECURITY.mdwith:Once merged, GitHub will display a "Security policy" link on the repository's Security tab.
Closes #282
Test plan
.github/SECURITY.md)