Skip to content

[CONTENT-3798] README update for marketing - #1840

Merged
felix-pauck-sonarsource merged 2 commits into
masterfrom
CONTENT-3798-readme-marketing-update
Oct 15, 2026
Merged

felix-pauck-sonarsource merged 2 commits into
masterfrom
CONTENT-3798-readme-marketing-update

Conversation

@tom-howlett-sonarsource

@tom-howlett-sonarsource tom-howlett-sonarsource commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR makes a deliberately small README update:

  • Replaces the promotional PHP opener with a factual description of the PHP analyzer and its maintainer audience, and links to current PHP analysis information.
  • Adds the approved responsive Sonar header, explicit Marketing ownership, and a relevant Sonar marketing-site link.
  • Clarifies maintainer review responsibility without adding or changing CODEOWNERS rules.
  • Preserves existing technical instructions, supported-version statements, contribution/support policy, and licensing.

Review guidance

These changes were prepared automatically using the shared README guidelines.

Please review the diff carefully for repository-specific accuracy, verify the logo in GitHub light and dark modes, and confirm that all required checks pass.

Merge ownership

If the changes are accurate and all required checks pass, please have a repository maintainer merge this PR. The rollout author will not merge it. If a check fails or a correction is needed, leave the PR unmerged and add a review comment.

Validation

  • Reconciled with the default branch at d5473dd79d955f5e10836d63abad272640b904c0.
  • Checked protected technical and legal content, Markdown fences, and the Marketing boundary.
  • Link and rendering evidence is recorded in the central package; inspect it before publication.
  • Only README.md changes; no runtime code is modified.

Tracking

Jira epic: CONTENT-3798

@hashicorp-vault-sonar-prod

hashicorp-vault-sonar-prod Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

CONTENT-3798

Comment thread README.md Outdated
@sonarqube-next

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0 Dependency risks
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@felix-pauck-sonarsource

felix-pauck-sonarsource commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

@tom-howlett-sonarsource is this ready for review?
Re-ran CI - it is green now 😉

@gitar-bot

gitar-bot Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Code Review ✅ Approved 1 closed / 1 findings

🟢 Low risk · README.md adds branding and marketing copy while preserving technical guidance; this documentation-only change leaves executable behavior unchanged.

README updates clarify the PHP analyzer description and add approved Sonar branding with marketing ownership. Marketing comment dependency has been resolved; CODEOWNERS review will apply to the changes.

✅ 1 closed
✅ Quality: Marketing comment relies on CODEOWNERS review that never applies to README

📄 README.md:18
The new comment at README.md:18 says that "Repository CODEOWNERS review accuracy and merge changes" to this Marketing section, and the PR asks for a CODEOWNER to merge it. But .github/CODEOWNERS has only one rule, .github/CODEOWNERS @SonarSource/code-security-taint-static-typed-languages-squad, which covers just that file. No code owner is set for README.md, so GitHub never requests a CODEOWNERS review when this section changes. The process the comment describes isn't enforced. Fix this either by adding a README.md rule to CODEOWNERS (for example, the squad team, plus Marketing if they should approve wording) or by changing the comment so it doesn't promise a CODEOWNERS review.

Verification Rules 2/2 met

Functional validation No results

Rules 2 passed 1 not applicable

✅ Internal artifact registries
✅ Repository license compliance

Auto-approval Not enabled

Set up

For more verification details, comment gitar display:verbose.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing compact verification results.

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

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@felix-pauck-sonarsource felix-pauck-sonarsource left a comment

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.

LGTM! 👍

@felix-pauck-sonarsource
felix-pauck-sonarsource merged commit 866c26b into master Oct 15, 2026
53 of 55 checks passed
@felix-pauck-sonarsource
felix-pauck-sonarsource deleted the CONTENT-3798-readme-marketing-update branch October 15, 2026 05:40
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.

2 participants