Skip to content

Add SECURITY.md, rename README.md, and fix stale repo URLs#242

Merged
garyo merged 2 commits into
AcademySoftwareFoundation:mainfrom
garyo:docs/add-security-fix-urls
Jun 15, 2026
Merged

Add SECURITY.md, rename README.md, and fix stale repo URLs#242
garyo merged 2 commits into
AcademySoftwareFoundation:mainfrom
garyo:docs/add-security-fix-urls

Conversation

@garyo

@garyo garyo commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Addresses the OpenFX findings from the ASWF project health report.

Changes

SECURITY.md (new) — adds a security policy at the repo root: vulnerability reporting via GitHub private security advisories, a 5-business-day acknowledgment SLA, a supported-versions table, and an OpenFX-specific security model section (the host/plug-in trust boundary — plug-ins are native code loaded into the host process).

README — renamed readme.mdREADME.md so GitHub surfaces it automatically. This also repairs the already-uppercase references in conanfile.py and pyproject.toml, and the casing reference in scripts/build-cmake.sh.

CONTRIBUTING.md

  • Fixed three issue-tracker URLs: github.com/ofxa/openfxgithub.com/AcademySoftwareFoundation/openfx.
  • Fixed the copy-pasted mailing list [email protected][email protected].
  • Fixed the broken [SECURITY.md] reference to a working link now that the file exists.

Repo-wide URL cleanup — replaced all remaining stale ofxa/openfx references and updated repo-relative links from the old master branch to main across README.md, STANDARD_PROCESS.md, release-notes.md, Documentation/sourceforge/index.html, and the Documentation/sources/**/*.rst files (also upgraded one http:// link to https://).

After this change there are zero remaining ofxa/openfx references and zero openfx/{blob,tree,raw}/master links in the tree.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates repository documentation and project metadata to address ASWF project health report findings by adding a security policy, standardizing README casing for GitHub, and refreshing stale repository/branch URLs throughout docs.

Changes:

  • Added a root SECURITY.md describing vulnerability reporting, supported versions, and the host/plug-in trust boundary.
  • Renamed/standardized README.md casing and adjusted references to match.
  • Replaced stale ofxa/openfx and master-branch links with AcademySoftwareFoundation/openfx and main across markdown, HTML, and Sphinx .rst docs.

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
STANDARD_PROCESS.md Updates the “Standard Change Proposal” issue-template link to the current GitHub org/repo.
SECURITY.md Introduces a security policy and reporting process at the repo root.
scripts/build-cmake.sh Updates error text to reference README.md (matching renamed file casing).
release-notes.md Updates programming guide link to the current repo/branch.
README.md Fixes stale links and ensures README is properly surfaced by GitHub via correct casing.
Documentation/sourceforge/index.html Updates the repository link to the current GitHub org/repo and uses https.
CONTRIBUTING.md Fixes stale issue tracker URLs, mailing list address, and adds a working SECURITY.md link.
Documentation/sources/Reference/suites/ofxDrawSuiteReference.rst Updates header-source link from master to main.
Documentation/sources/Reference/ofxThreadSafety.rst Updates header-source link to current org/repo/branch.
Documentation/sources/Reference/ofxStructure.rst Updates header-source links to current org/repo/branch.
Documentation/sources/Reference/ofxStatusCodes.rst Updates header-source link to current org/repo/branch.
Documentation/sources/Reference/ofxParameter.rst Updates header-source link from master to main.
Documentation/sources/Reference/ofxImageEffectAPI.rst Updates multiple header-source links and org/repo references.
Documentation/sources/Reference/ofxImageEffectActions.rst Updates header-source links from master to main.
Documentation/sources/Reference/ofxImageClip.rst Updates header-source link to current org/repo/branch.
Documentation/sources/Reference/ofxCoreAPI.rst Updates header-source links from master to main.
Documentation/sources/Guide/ofxExamples.rst Updates repo link to current GitHub org/repo.
Documentation/sources/Guide/ofxExample1_Basics.rst Updates example source links from master to main.
Documentation/sources/Guide/ofxExample2_Invert.rst Updates example source link from master to main.
Documentation/sources/Guide/ofxExample3_Gain.rst Updates example source link from master to main.
Documentation/sources/Guide/ofxExample4_Saturation.rst Updates example source link from master to main.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread STANDARD_PROCESS.md
@garyo garyo requested a review from john-paulsmith June 14, 2026 14:22
Signed-off-by: Gary Oberbrunner <[email protected]>

@lgritz lgritz left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I like the clear SECURITY guide, good discussion about the boundaries.

@garyo garyo merged commit 3e6f27f into AcademySoftwareFoundation:main Jun 15, 2026
9 of 10 checks passed
@garyo garyo deleted the docs/add-security-fix-urls branch June 15, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants