Skip to content

docs: Add security policy.#281

Merged
nedseb merged 2 commits into
mainfrom
docs/security-policy
Mar 28, 2026
Merged

docs: Add security policy.#281
nedseb merged 2 commits into
mainfrom
docs/security-policy

Conversation

@nedseb
Copy link
Copy Markdown
Contributor

@nedseb nedseb commented Mar 28, 2026

Summary

Add .github/SECURITY.md with:

  • Supported versions (most recent tagged release only)
  • How to report vulnerabilities (GitHub Security Advisories or email)
  • What to include in a report
  • Response timeline (7 days ack, 30 days fix)
  • Scope (driver library and tooling, not firmware, hardware, or third-party deps)
  • Automated security features in use (Dependabot alerts, CodeQL analysis, secret scanning)

Once merged, GitHub will display a "Security policy" link on the repository's Security tab.

Closes #282

Test plan

  • SECURITY.md follows GitHub's expected path (.github/SECURITY.md)
  • Report link points to the correct advisory URL

Copilot AI review requested due to automatic review settings March 28, 2026 15:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing 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.

Comment thread .github/SECURITY.md Outdated

* 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)
Copy link

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
* 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)

Copilot uses AI. Check for mistakes.
Comment thread .github/SECURITY.md Outdated
Comment on lines +44 to +48
This repository uses:

* **Dependabot** for automated dependency vulnerability alerts
* **CodeQL** for static analysis on CI workflows
* **Secret scanning** for detecting leaked credentials
Copy link

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
Comment thread .github/SECURITY.md Outdated
| latest release | Yes |
| older releases | No |

Only the latest release on the `main` branch receives security updates.
Copy link

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

Suggested change
Only the latest release on the `main` branch receives security updates.
Only the most recent tagged release receives security updates.

Copilot uses AI. Check for mistakes.
@nedseb
Copy link
Copy Markdown
Contributor Author

nedseb commented Mar 28, 2026

Les trois remarques de Copilot ont été corrigées dans cdcee53 :

  1. "latest release on the main branch" → "most recent tagged release" — plus précis, les releases sont des tags.
  2. Third-party npm dependencies → "Third-party dependencies (npm packages, Python packages)" — couvre aussi les dépendances Python.
  3. CodeQL/Dependabot pas configurés → Copilot a tort, les deux sont actifs (3 alertes CodeQL, 13 alertes Dependabot via les settings du repo). Le texte a été reformulé en "GitHub security features enabled" pour plus de clarté.

@nedseb nedseb mentioned this pull request Mar 28, 2026
2 tasks
@nedseb nedseb merged commit d3230d8 into main Mar 28, 2026
10 checks passed
@nedseb nedseb deleted the docs/security-policy branch March 28, 2026 15:58
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.

docs: Add security policy.

2 participants