Skip to content

docs: deduplicate security content and align with onboarding guidelines#9

Open
nexus49 wants to merge 2 commits intoneonephos:mainfrom
nexus49:docs/deduplicate-security-content
Open

docs: deduplicate security content and align with onboarding guidelines#9
nexus49 wants to merge 2 commits intoneonephos:mainfrom
nexus49:docs/deduplicate-security-content

Conversation

@nexus49
Copy link
Copy Markdown

@nexus49 nexus49 commented Apr 7, 2026

Summary

This PR removes duplicated security content from the project guidelines and replaces it with cross-references to the NeoNephos Security Guidelines, establishing a single source of truth for security requirements. It also aligns priority levels and terminology between the project guidelines and onboarding guidelines.

Depends on #7 (security guidelines) being merged first — the cross-references target sections introduced by that PR.

Changes and reasoning

Security deduplication (project-guidelines.md)

  • §6 Security Disclosure: Replaced four inline MUST/SHOULD bullets (SECURITY.md, disclosure contacts, private reporting, alternative channels) with a single reference to the security guidelines. These requirements are fully covered by Security Guidelines §5 and §6.
  • §6 Dependency Management: Replaced the MAY generate SBOMs bullet with a reference to Security Guidelines §8 (Supply Chain Security), which defines SBOM, dependency scanning, signing, and provenance requirements.
  • §11 Security: Expanded the section description to clarify what the security guidelines cover (vulnerability disclosure, supply chain, transparency). Removed the sentence splitting scope between §15.3 and the security guidelines — all security content should live in one place.
  • §15.1 Artifact Hosting: Updated the artifact signing reference to point directly to Security Guidelines §8 instead of §11.
  • §15.3 Security and Compliance: Collapsed the entire section (mandatory + supplemental compliance: 2FA, GitHub Actions, runners, data retention, maintainer permissions, CI hardening) into a single reference to the security guidelines. This content should be absorbed into the security guidelines document. Also fixed the "must they must" typo and inconsistent punctuation while the section was being edited.
  • TOC: Removed 15.3.1 and 15.3.2 sub-entries that no longer exist.

Onboarding alignment (both documents)

  • §4 Technical Charters: Upgraded from SHOULD to MUST to match the onboarding requirement that projects must publish their charter.
  • §5 Security Officer: Added a new requirement (MUST designate a Security Officer) that was present in onboarding but missing from project guidelines.
  • §6 Data Collection and Privacy: Added three new requirements from onboarding that had no equivalent in project guidelines: data collection documentation with opt-out, PII exclusion from telemetry, and Data Processing Notice.
  • onboarding-guidelines.md: Aligned "Linux Foundation Code of Conduct" → "NeoNephos Code of Conduct" (with link) and "LF-approved licenses" → "licenses approved through their Project Charter" to match the project guidelines terminology.

Editorial fixes

  • Fixed "goverened" typo in §1.
  • Fixed trailing semicolon in §8 Related sections.

Remove security-related content from project-guidelines that is covered
by the upcoming NeoNephos Security Guidelines, replacing inline
requirements with cross-references. Align priority levels and
terminology between project-guidelines and onboarding-guidelines.

Signed-off-by: Bastian Echterhölter <bastian.echterhoelter@sap.com>
On-behalf-of: @SAP <bastian.echterhoelter@sap.com>
@nexus49 nexus49 requested a review from a team April 7, 2026 13:56

* **MUST** publish a project charter (canonical + Markdown).
* **MUST** adopt the Linux Foundation Code of Conduct.
* **MUST** adopt the [NeoNephos Code of Conduct](https://github.com/neonephos/.github/blob/main/CODE_OF_CONDUCT.md).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is problematic, as each project has definied in it's techincal charter to use the LF Europe CoC unless the project has it's own pre-approved ( see 4c).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See PR #3.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

ok is it NeoNephos Code of Conduct or LF Europe CoC ?

| **MUST** | By next minor release | TSC |

Each project **SHOULD** make its project charter publicly available (website or repository). If converted to Markdown, the Markdown version **MUST** remain synchronized with the canonical source.
Each project **MUST** make its project charter publicly available (website or repository). If converted to Markdown, the Markdown version **MUST** remain synchronized with the canonical source.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Let's never say people can convert or copy the charter - we can provide the link to the source doc hosted by the LF.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

we can also change the wording, I took the wording from the onboardind guide here:
https://github.com/neonephos/guidelines-development/blob/main/onboarding/onboarding-guidelines.md?plain=1#L17

I'll adjust to make it a link to the source doc on both documents.


* Projects **MUST** track third-party licenses.
* Projects **MAY** generate SBOMs for generated artifacts.
* For dependency scanning and SBOM requirements, see [NeoNephos Security Guidelines §8 — Supply Chain Security](../security-guidelines/security-guidelines.md#8-supply-chain-security).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We should bring in the LF License Scanning program to help here. I can have that lead come to a TAC meeting to discuss.

Projects must link to their centrally hosted charter rather than
publishing or converting copies.

Signed-off-by: Bastian Echterhölter <bastian.echterhoelter@sap.com>
On-behalf-of: @SAP <bastian.echterhoelter@sap.com>
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.

3 participants