Skip to content

Commit c903f82

Browse files
authored
docs: plainer SUPPORT and SECURITY, and a dash-free canonical AGENTS.md paragraph (#133)
1 parent b20fa3e commit c903f82

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎SECURITY.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Reporting a vulnerability
44

5-
Please **do not** open a public issue for security problems.
5+
Please do not open a public issue for security problems.
66

77
Report vulnerabilities privately using GitHub's built-in private reporting:
88
open the affected repository's **Security** tab and choose
@@ -20,6 +20,6 @@ in the release notes unless you prefer to remain anonymous.
2020

2121
## Supported versions
2222

23-
Unless a repository states otherwise, security fixes target the **latest
24-
released version** on PyPI. Upgrading to the latest release is the recommended
23+
Unless a repository states otherwise, security fixes target the latest
24+
released version on PyPI. Upgrading to the latest release is the recommended
2525
way to receive fixes.

‎SUPPORT.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Support
22

3-
Need help with a `modern-python` project? Here's where to go:
3+
Where to get help with a `modern-python` project:
44

5-
- **Documentation:** start at [modern-python.org](https://modern-python.org) and
5+
- For documentation, start at [modern-python.org](https://modern-python.org) and
66
the project's own docs site (linked from each repo).
7-
- **Questions & usage help:** ask in
7+
- For questions and usage help, ask in
88
[GitHub Discussions](https://github.com/orgs/modern-python/discussions).
9-
- **Bugs & feature requests:** open an issue in the relevant repository using the
9+
- For bugs and feature requests, open an issue in the relevant repository using the
1010
provided templates.
11-
- **Security issues:** see [SECURITY.md](SECURITY.md) — please report privately,
11+
- For security issues, see [SECURITY.md](SECURITY.md). Please report them privately,
1212
not in a public issue.
1313

14-
Please search existing issues and discussions before opening a new one — your
14+
Please search existing issues and discussions before opening a new one, since your
1515
question may already be answered.

‎docs/standard.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ isort.no-lines-before = ["standard-library", "local-folder"]
510510
The canonical paragraphs for [FL2](#FL2).
511511

512512
```markdown
513-
`just` (task runner) and `uv` (package manager). The [`justfile`](justfile) is the source of truth —
513+
`just` (task runner) and `uv` (package manager). The [`justfile`](justfile) is the source of truth:
514514
`just --list`, or read it.
515515
```
516516

0 commit comments

Comments
 (0)