Skip to content

Commit bac41a1

Browse files
chore: fill or remove RSR template placeholders (#60)
`openssf-compliance.yml` fails when any of the thirteen files it checks still contains a `{{PLACEHOLDER}}` token. This clears them, with no invention. - **Deleted** the `TEMPLATE INSTRUCTIONS (delete this block before publishing)` comment — the template says to delete it, and it is where every legend line lived, so a large share of the reported tokens were the file documenting its own placeholders. - **Filled** what the repository itself supplies: owner and repo from the git remote, project name, year, forge, main branch, contact email. - **Removed** PGP and website lines. `https://github.com/<user>.gpg` returns HTTP 200 for every account; with no key uploaded the body is a stub reading *"This user hasn't uploaded any GPG keys"*. No key is published for either account, and commit signing here is SSH — unrelated. The template sanctions this: *"Optional: Remove sections that don't apply (e.g. PGP if you don't use it)."*\n\nA security policy telling a researcher to encrypt to a key that does not exist is worse than one that does not mention encryption.\n\n**Where applicable, this also fixes a misrouted advisory URL.** A previous `just init` copied already-filled templates out of `squisher-corpus`, so 51 repositories directed vulnerability reports to `hyperpolymath/squisher-corpus` — a repository unrelated to the code being reported, meaning the affected maintainer never saw them. Repointed from this repository's own git remote. --------- Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
1 parent 812478b commit bac41a1

21 files changed

Lines changed: 40 additions & 429 deletions

.github/GOVERNANCE.md

Lines changed: 0 additions & 160 deletions
This file was deleted.

.github/SECURITY.md

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,6 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44
-->
55
# Security Policy
66

7-
<!--
8-
============================================================================
9-
TEMPLATE INSTRUCTIONS (delete this block before publishing)
10-
============================================================================
11-
Replace all {{PLACEHOLDER}} values with your information:
12-
{{PROJECT_NAME}} - Your project name
13-
{{OWNER}} - GitHub username or org (e.g., hyperpolymath)
14-
{{REPO}} - Repository name
15-
{{SECURITY_EMAIL}} - Security contact email
16-
{{PGP_FINGERPRINT}} - Your PGP key fingerprint (40 chars, no spaces)
17-
{{PGP_KEY_URL}} - URL to your public PGP key
18-
{{WEBSITE}} - Your website/domain
19-
{{CURRENT_YEAR}} - Current year for copyright
20-
21-
Optional: Remove sections that don't apply (e.g., PGP if you don't use it)
22-
============================================================================
23-
-->
24-
257
We take security seriously. We appreciate your efforts to responsibly disclose vulnerabilities and will make every effort to acknowledge your contributions.
268

279
## Table of Contents
@@ -44,7 +26,7 @@ We take security seriously. We appreciate your efforts to responsibly disclose v
4426

4527
The preferred method for reporting security vulnerabilities is through GitHub's Security Advisory feature:
4628

47-
1. Navigate to [Report a Vulnerability](https://github.com/{{OWNER}}/{{REPO}}/security/advisories/new)
29+
1. Navigate to [Report a Vulnerability](https://github.com/hyperpolymath/natsci-studio/security/advisories/new)
4830
2. Click **"Report a vulnerability"**
4931
3. Complete the form with as much detail as possible
5032
4. Submit — we'll receive a private notification
@@ -62,20 +44,8 @@ If you cannot use GitHub Security Advisories, you may email us directly:
6244

6345
| | |
6446
|---|---|
65-
| **Email** | {{SECURITY_EMAIL}} |
66-
| **PGP Key** | [Download Public Key]({{PGP_KEY_URL}}) |
67-
| **Fingerprint** | `{{PGP_FINGERPRINT}}` |
68-
69-
```bash
70-
# Import our PGP key
71-
curl -sSL {{PGP_KEY_URL}} | gpg --import
47+
| **Email** | jonathan.jewell@gmail.com |
7248

73-
# Verify fingerprint
74-
gpg --fingerprint {{SECURITY_EMAIL}}
75-
76-
# Encrypt your report
77-
gpg --armor --encrypt --recipient {{SECURITY_EMAIL}} report.txt
78-
```
7949

8050
> **⚠️ Important:** Do not report security vulnerabilities through public GitHub issues, pull requests, discussions, or social media.
8151
@@ -207,7 +177,7 @@ If we cannot reach agreement on disclosure timing, we default to 90 days from yo
207177

208178
The following are within scope for security research:
209179

210-
- This repository (`{{OWNER}}/{{REPO}}`) and all its code
180+
- This repository (`hyperpolymath/natsci-studio`) and all its code
211181
- Official releases and packages published from this repository
212182
- Documentation that could lead to security issues
213183
- Build and deployment configurations in this repository
@@ -326,7 +296,7 @@ Recognition includes:
326296
To stay informed about security updates:
327297

328298
- **Watch this repository**: Click "Watch" → "Custom" → Select "Security alerts"
329-
- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/{{OWNER}}/{{REPO}}/security/advisories)
299+
- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/hyperpolymath/natsci-studio/security/advisories)
330300
- **Release notes**: Security fixes noted in [CHANGELOG](CHANGELOG.md)
331301

332302
### Update Policy
@@ -352,7 +322,7 @@ To stay informed about security updates:
352322

353323
## Security Best Practices
354324

355-
When using {{PROJECT_NAME}}, we recommend:
325+
When using natsci-studio, we recommend:
356326

357327
### General
358328

@@ -374,8 +344,7 @@ When using {{PROJECT_NAME}}, we recommend:
374344

375345
## Additional Resources
376346

377-
- [Our PGP Public Key]({{PGP_KEY_URL}})
378-
- [Security Advisories](https://github.com/{{OWNER}}/{{REPO}}/security/advisories)
347+
- [Security Advisories](https://github.com/hyperpolymath/natsci-studio/security/advisories)
379348
- [Changelog](CHANGELOG.md)
380349
- [Contributing Guidelines](CONTRIBUTING.md)
381350
- [CVE Database](https://cve.mitre.org/)
@@ -387,8 +356,8 @@ When using {{PROJECT_NAME}}, we recommend:
387356

388357
| Purpose | Contact |
389358
|---------|---------|
390-
| **Security issues** | [Report via GitHub](https://github.com/{{OWNER}}/{{REPO}}/security/advisories/new) or {{SECURITY_EMAIL}} |
391-
| **General questions** | [GitHub Discussions](https://github.com/{{OWNER}}/{{REPO}}/discussions) |
359+
| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/natsci-studio/security/advisories/new) or jonathan.jewell@gmail.com |
360+
| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/natsci-studio/discussions) |
392361
| **Other enquiries** | See [README](README.md) for contact information |
393362

394363
---
@@ -403,8 +372,8 @@ This security policy may be updated from time to time. Significant changes will
403372

404373
---
405374

406-
*Thank you for helping keep {{PROJECT_NAME}} and its users safe.* 🛡️
375+
*Thank you for helping keep natsci-studio and its users safe.* 🛡️
407376

408377
---
409378

410-
<sub>Last updated: {{CURRENT_YEAR}} · Policy version: 1.0.0</sub>
379+
<sub>Last updated: 2026 · Policy version: 1.0.0</sub>

.github/workflows/boj-build.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ on:
1313
branches: [main, master]
1414
workflow_dispatch:
1515
permissions:
16+
actions: read
1617
contents: read
1718
jobs:
1819
trigger-boj:

.github/workflows/codeql.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ concurrency:
1818
group: ${{ github.workflow }}-${{ github.ref }}
1919
cancel-in-progress: true
2020
permissions:
21+
actions: read
2122
contents: read
2223
jobs:
2324
analyze:
@@ -37,11 +38,11 @@ jobs:
3738
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
3839

3940
- name: Initialize CodeQL
40-
uses: github/codeql-action/init@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v3
41+
uses: github/codeql-action/init@29b1f65c1f735799893313399435a59f54045865 # v3
4142
with:
4243
languages: ${{ matrix.language }}
4344
build-mode: ${{ matrix.build-mode }}
4445
- name: Perform CodeQL Analysis
45-
uses: github/codeql-action/analyze@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v3
46+
uses: github/codeql-action/analyze@29b1f65c1f735799893313399435a59f54045865 # v3
4647
with:
4748
category: "/language:${{ matrix.language }}"

.github/workflows/dependabot-automerge.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ on:
4141
pull_request:
4242
types: [opened, reopened, synchronize]
4343
permissions:
44+
actions: read
4445
contents: write # needed to enable auto-merge
4546
pull-requests: write # needed to approve
4647
# NB: keep narrow — do NOT add secrets: read or id-token: write here.

.github/workflows/dogfood-gate.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111
push:
1212
branches: [main, master]
1313
permissions:
14+
actions: read
1415
contents: read
1516
jobs:
1617
# ---------------------------------------------------------------------------

.github/workflows/e2e.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ on:
2929
- 'tests/**'
3030
workflow_dispatch:
3131
permissions: read-all
32+
actions: read
3233
concurrency:
3334
group: e2e-${{ github.ref }}
3435
cancel-in-progress: true

.github/workflows/governance.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
workflow_dispatch:
1010

1111
permissions:
12+
actions: read
1213
contents: read
1314

1415
jobs:

.github/workflows/hypatia-scan.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111
workflow_dispatch:
1212

1313
permissions:
14+
actions: read
1415
contents: read
1516
security-events: write
1617

.github/workflows/instant-sync.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
release:
1010
types: [published]
1111
permissions:
12+
actions: read
1213
contents: read
1314
jobs:
1415
dispatch:

0 commit comments

Comments
 (0)