Skip to content

chore: fill or remove RSR template placeholders - #23

Merged
hyperpolymath merged 3 commits into
mainfrom
fix/rsr-placeholders
Jul 28, 2026
Merged

chore: fill or remove RSR template placeholders#23
hyperpolymath merged 3 commits into
mainfrom
fix/rsr-placeholders

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

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\nWhere 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.

hyperpolymath and others added 2 commits July 26, 2026 14:51
openssf-compliance.yml fails when any of the thirteen files it checks
still contains a {{PLACEHOLDER}} token. This clears them.

Three kinds of change, no invention:

The "TEMPLATE INSTRUCTIONS (delete this block before publishing)" comment
is deleted. The template says to delete it, and it is where every legend
line lives -- so a large share of the reported tokens were the file
documenting its own placeholders, not real unfilled fields.

Tokens derivable from the repository are filled: owner and repo from the
git remote, project name, year, forge, main branch, contact email.

PGP and website lines are removed rather than filled, because nothing
true could go in them. https://github.com/<user>.gpg returns HTTP 200 for
every account; with no key uploaded the body is a stub reading "This user
hasnt uploaded any GPG keys". No key is published for either account
here, and commit signing in this estate is SSH, which is unrelated. Only
one repository in the estate has a domain, so {{WEBSITE}} likewise has no
correct value. The template sanctions this: "Optional: Remove sections
that dont apply (e.g. PGP if you dont use it)." A security policy telling
a researcher to encrypt to a key that does not exist is worse than one
that does not mention encryption.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
Comment thread CONTRIBUTING.md
Comment thread SECURITY.md
Comment thread CODE_OF_CONDUCT.md
@gitar-bot

gitar-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

Note

Automatic reviews are paused because your trial's included automatic processing has been used for this period. Upgrade now, or comment "Gitar review" to run a review anytime.
Learn more

CI failed: CI failed because the CodeQL GitHub Action reference in `.github/workflows/codeql.yml` points to an unresolvable commit SHA.

Overview

A single configuration failure occurred in the CI pipeline due to an invalid action reference in the CodeQL workflow file.

Failures

Unresolvable CodeQL Action Version (confidence: high)

  • Type: configuration
  • Affected jobs: 90327140572
  • Related to change: yes
  • Root cause: The CodeQL action reference in .github/workflows/codeql.yml uses a commit SHA (29b1f65c1f735799893313399435a59f54045865) that cannot be found or resolved by GitHub Actions.
  • Suggested fix: Update .github/workflows/codeql.yml to use a valid tag, branch, or release SHA for github/codeql-action (e.g., @v3 or a valid current commit SHA).

Summary

  • Change-related failures: 1 configuration error in .github/workflows/codeql.yml
  • Infrastructure/flaky failures: None
  • Recommended action: Update the CodeQL action reference to a valid version tag or SHA.
Code Review ✅ Approved 3 resolved / 3 findings

Replaces template placeholders across repository documentation to satisfy OpenSSF compliance, but leaves CONTRIBUTING.md malformed, SECURITY.md referencing a nonexistent PGP key, and CODE_OF_CONDUCT.md with unaddressed template blocks and misrouted URLs.

✅ 3 resolved
Quality: CONTRIBUTING.md is malformed: missing header and unbalanced code fences

📄 CONTRIBUTING.md:1-15 📄 CONTRIBUTING.md:111-116
The file starts at line 1 with # Clone the repository followed by raw shell commands, and line 16 has a closing fence with no matching opening fence — the document title, intro, and the opening of the setup code block are all missing. It also ends abruptly at line 116 (`[optional footer]`) inside an unterminated code block. As rendered, the shell commands appear as prose/headings and the trailing block never closes. The top and bottom of the file appear to have been truncated; restore the missing heading/opening fence and add the closing so the Markdown renders correctly.

Quality: CODE_OF_CONDUCT.md keeps template block, wrong project name and misrouted URL

📄 CODE_OF_CONDUCT.md:3-17 📄 CODE_OF_CONDUCT.md:25 📄 CODE_OF_CONDUCT.md:313
The PR description says the TEMPLATE INSTRUCTIONS (delete this block before publishing) comment was deleted and misrouted advisory/discussion URLs were repointed, but CODE_OF_CONDUCT.md still contains that instruction block (lines 3-21), names the project "Squisher Corpus" in Our Pledge (line 25), and links Discussions to https://github.com/hyperpolymath/squisher-corpus/discussions (line 313) — the exact unrelated repository the PR aims to stop routing people to. Delete the template block, change the project name to "Rescript Ecosystem", and repoint the Discussions link to hyperpolymath/rescript-ecosystem.

Quality: SECURITY.md still advertises a nonexistent PGP key and TBD fingerprint

📄 SECURITY.md:41-55 📄 SECURITY.md:355 📄 CODE_OF_CONDUCT.md:44-56
The PR description states PGP/website lines were removed because no key is published and https://github.com/hyperpolymath.gpg returns only a stub, yet SECURITY.md still lists a PGP Key link, a Fingerprint of TBD, curl import/encrypt instructions, and an "Our PGP Public Key" resource link. This is exactly the situation the PR calls "worse than one that does not mention encryption" — researchers will try to encrypt to a key that does not exist, and the TBD fingerprint is an unfilled placeholder. Remove the PGP row, the fingerprint row, the gpg code block, and the Additional Resources PGP link to match the stated intent.

Tip

Comment Gitar fix CI to trigger a fix.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 13ac651 into main Jul 28, 2026
3 checks passed
@hyperpolymath
hyperpolymath deleted the fix/rsr-placeholders branch July 28, 2026 17:03
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.

1 participant