Skip to content

Commit 5f9737b

Browse files
committed
docs: tailor security policy and PR template for the plugin template
Build on the initial community-files commit: - SECURITY.md: concrete disclosure channels (GitHub Private Vulnerability Reporting + security@mloda.ai), realistic supported-versions note, get-in-touch response wording, and a customization note for forks. - PR template: drop issue-template frontmatter and the hardcoded issue link; align the checklist with the tox gate and conventional commits.
1 parent e8e824c commit 5f9737b

2 files changed

Lines changed: 59 additions & 28 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
---
2-
name: Pull Request
3-
about: Submit a pull request
4-
title: ''
5-
assignees: ''
6-
---
1+
<!--
2+
Thanks for contributing! A few notes before you submit:
3+
- Use a Conventional Commit style PR title (e.g. `fix:`, `feat:`, `docs:`, `chore:`).
4+
- Keep the description focused; delete sections that don't apply.
5+
-->
76

87
## Summary
98

10-
<!-- Briefly describe what this PR accomplishes. -->
9+
<!-- What does this PR change, and why? One or two sentences is plenty. -->
1110

12-
## Related Issue
11+
## Related issue
1312

14-
Closes #468
13+
<!-- Link the issue this closes, e.g. "Closes #123". Leave blank if none. -->
14+
Closes #
1515

16-
## Checklist
16+
## Type of change
1717

18-
- [ ] Tests pass locally
19-
- [ ] New tests added for new functionality
20-
- [ ] Documentation updated
21-
- [ ] Conventional commit message format used
18+
- [ ] Bug fix (`fix:`)
19+
- [ ] New feature (`feat:`)
20+
- [ ] Documentation (`docs:`)
21+
- [ ] Refactor / maintenance (`refactor:` / `chore:`)
22+
- [ ] Other (explain below)
2223

23-
## Type of Change
24+
## Checklist
2425

25-
- [ ] Bug fix
26-
- [ ] New feature
27-
- [ ] Documentation update
28-
- [ ] Refactoring
29-
- [ ] Other
26+
- [ ] `tox` passes locally (tests, `ruff format --check`, `ruff check`, `mypy --strict`, `bandit`)
27+
- [ ] Tests added or updated for the change
28+
- [ ] Documentation updated where relevant
29+
- [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/)

SECURITY.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,48 @@
11
# Security Policy
22

3+
> **Template note:** This file ships with the plugin template. If you create a
4+
> plugin from it, update the contact below to your own private channel (and
5+
> keep or remove this note as you see fit).
6+
37
## Supported Versions
48

5-
| Version | Supported |
6-
| ------- | --------- |
7-
| latest ||
9+
Security fixes are applied to the latest released version and the `main`
10+
branch. We do not backport fixes to older releases — please upgrade to the
11+
latest version before reporting.
12+
13+
| Version | Supported |
14+
| -------------- | ------------------ |
15+
| Latest release | :white_check_mark: |
16+
| Older releases | :x: |
817

918
## Reporting a Vulnerability
1019

11-
If you discover a security vulnerability, please report it privately.
20+
**Please do not report security vulnerabilities through public GitHub issues,
21+
pull requests, or discussions.** This keeps users protected while a fix is
22+
prepared.
23+
24+
Instead, use one of these private channels:
25+
26+
1. **GitHub Private Vulnerability Reporting** (preferred) — open the **Security**
27+
tab of this repository and click **Report a vulnerability**. This keeps the
28+
report, discussion, and coordinated disclosure in one place.
29+
2. **Email** — for plugins in the mloda organization, write to
30+
**security@mloda.ai**. If you forked this template, use your own address.
31+
32+
Please include as much of the following as you can:
33+
34+
- The type of issue (e.g. injection, path traversal, deserialization,
35+
dependency vulnerability).
36+
- The affected module or file path (`file.py:line` if known).
37+
- Step-by-step reproduction or a proof of concept.
38+
- The potential impact and any suggested mitigation.
39+
40+
## What to Expect
1241

13-
**Do not file a public issue.** Send a description to the maintainers via one of:
14-
1. **GitHub Private Vulnerability Reporting** — use the "Report a vulnerability" link on the Security tab.
15-
2. **Email** — contact the maintainers directly.
42+
- We'll get in touch to acknowledge your report.
43+
- We'll assess the severity and keep you updated as we work toward a fix.
44+
- We're happy to credit you in the advisory once it's published, unless you
45+
prefer to remain anonymous.
1646

17-
You should receive a response within 72 hours.
47+
We follow coordinated disclosure: we ask that you give us a reasonable window
48+
to release a fix before any public disclosure.

0 commit comments

Comments
 (0)