Skip to content

Commit 7e3947f

Browse files
claudehyperpolymath
authored andcommitted
docs(governance): fill required-file placeholders + fix project naming
Remove unfilled {{PLACEHOLDER}} tokens from the openssf-compliance gate's required-file set so the gate passes, without touching legitimate template files (k9 *.ncl, contractiles, container/well-known stubs, e2e templates). - .machine_readable/ECOSYSTEM.a2ml: fill {{REPO_DESCRIPTION}} with the KRL one-line description from README.adoc. - .github/SECURITY.md: delete the rsr-template TEMPLATE INSTRUCTIONS block; remove the optional PGP section (no PGP key — {{PGP_KEY_URL}}/ {{PGP_FINGERPRINT}} had no fill value, and the template marks PGP optional). - .github/CODE_OF_CONDUCT.md: delete the TEMPLATE INSTRUCTIONS block (body already instantiated for krl). - .machine_readable/6a2/STATE.a2ml: drop META-TEMPLATE comment scaffolding referencing {{PLACEHOLDER}}; body already instantiated for krl. https://claude.ai/code/session_017TXizM5c1Yd9HWf7Y15YH2
1 parent c598574 commit 7e3947f

4 files changed

Lines changed: 4 additions & 60 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,6 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44
-->
55
# Code of Conduct
66

7-
<!--
8-
============================================================================
9-
TEMPLATE INSTRUCTIONS (delete this block before publishing)
10-
============================================================================
11-
Replace all {{PLACEHOLDER}} values:
12-
KRL - Your project name
13-
hyperpolymath - GitHub/GitLab username or org
14-
krl - Repository name
15-
jonathan.jewell@open.ac.uk - Email for conduct reports
16-
Code of Conduct Committee - Name of conduct team/committee
17-
48 hours - Initial response SLA (e.g., 48 hours)
18-
2026 - Current year
19-
20-
Review and customise:
21-
- Adjust enforcement ladder for your community size
22-
- Add/remove examples based on your context
23-
- Ensure contact methods work for your team
24-
============================================================================
25-
-->
26-
277
## Our Pledge
288

299
We as members, contributors, and leaders pledge to make participation in KRL a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.

.github/SECURITY.md

Lines changed: 1 addition & 33 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-
KRL - Your project name
13-
hyperpolymath - GitHub username or org (e.g., hyperpolymath)
14-
krl - Repository name
15-
jonathan.jewell@open.ac.uk - 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-
https://github.com/hyperpolymath/krl - Your website/domain
19-
2026 - 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
@@ -56,26 +38,13 @@ This method ensures:
5638
- Coordinated disclosure tooling
5739
- Automatic credit when the advisory is published
5840

59-
### Alternative: Encrypted Email
41+
### Alternative: Email
6042

6143
If you cannot use GitHub Security Advisories, you may email us directly:
6244

6345
| | |
6446
|---|---|
6547
| **Email** | jonathan.jewell@open.ac.uk |
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
72-
73-
# Verify fingerprint
74-
gpg --fingerprint jonathan.jewell@open.ac.uk
75-
76-
# Encrypt your report
77-
gpg --armor --encrypt --recipient jonathan.jewell@open.ac.uk report.txt
78-
```
7948

8049
> **⚠️ Important:** Do not report security vulnerabilities through public GitHub issues, pull requests, discussions, or social media.
8150
@@ -374,7 +343,6 @@ When using KRL, we recommend:
374343

375344
## Additional Resources
376345

377-
- [Our PGP Public Key]({{PGP_KEY_URL}})
378346
- [Security Advisories](https://github.com/hyperpolymath/krl/security/advisories)
379347
- [Changelog](CHANGELOG.md)
380348
- [Contributing Guidelines](CONTRIBUTING.md)

.machine_readable/6a2/STATE.a2ml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# SPDX-License-Identifier: MPL-2.0
22
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
33
#
4-
# STATE.a2ml — Project state checkpoint (META-TEMPLATE)
4+
# STATE.a2ml — Project state checkpoint
55
#
66
# This is the STATE file for krl.
7-
# When consumed by a new project, replace {{PLACEHOLDER}} tokens
8-
# and customize sections below for the target project.
97

108
[metadata]
119
project = "krl"
@@ -58,7 +56,5 @@ part-of = ["RSR Framework", "stapeln ecosystem"]
5856
depends-on = ["stapeln", "selur-compose", "cerro-torre", "svalinn", "vordr", "k9-svc"]
5957

6058
# ---------------------------------------------------------------------------
61-
# NOTE FOR CONSUMERS: When using this template to create a new repo, reset
62-
# the fields above to your project's values and replace all {{PLACEHOLDER}}
63-
# tokens. The milestones above describe the TEMPLATE's evolution, not yours.
59+
# NOTE: The milestones above describe the krl repository's evolution.
6460
# ---------------------------------------------------------------------------

.machine_readable/ECOSYSTEM.a2ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
(version "1.0.0")
55
(name "krl")
66
(type "library")
7-
(purpose "{{REPO_DESCRIPTION}}")
7+
(purpose "Knot Resolution Language — a compositional language for constructing, transforming, resolving, and retrieving topological objects: tangles, knots, and links")
88
(related-projects))

0 commit comments

Comments
 (0)