Skip to content

Comments

chore: Add Open Source Security Foundation best practices badge#785

Merged
MaxymVlasov merged 9 commits intomasterfrom
MaxymVlasov-patch-1
May 16, 2025
Merged

chore: Add Open Source Security Foundation best practices badge#785
MaxymVlasov merged 9 commits intomasterfrom
MaxymVlasov-patch-1

Conversation

@MaxymVlasov
Copy link
Collaborator

@MaxymVlasov MaxymVlasov commented Jan 26, 2025

Relates #712

@coderabbitai
Copy link

coderabbitai bot commented Jan 26, 2025

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added the OpenSSF Best Practices badge to the README.
    • Updated badge order and references for improved clarity.

Walkthrough

The pull request adds the OpenSSF Best Practices badge to the README.md file, placing it before the Codetriage badge and appending a corresponding reference link at the bottom. No other content or code changes were made.

Changes

File Change Summary
README.md Added OpenSSF Best Practices badge before Codetriage badge; moved Codetriage badge down; added reference link for OpenSSF badge at the bottom.

Suggested reviewers

  • yermulnik

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65c6dc5 and 0d08115.

📒 Files selected for processing (1)
  • README.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • README.md

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

yermulnik
yermulnik previously approved these changes Jan 26, 2025
@MaxymVlasov MaxymVlasov marked this pull request as draft January 27, 2025 15:41
@github-actions
Copy link

This PR has been automatically marked as stale because it has been open 30 days

with no activity. Remove stale label or comment or this PR will be closed in 10 days

@github-actions github-actions bot added the stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 25, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

33-33: Nit: Validate the badge image URL
The reference URL https://www.bestpractices.dev/projects/9963/badge should return an SVG. Some badge endpoints require an explicit .svg suffix. Confirm via browser or curl that the current path serves the image, or adjust (e.g. /badge.svg) if necessary.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e5f4170 and 17fc1a8.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🔇 Additional comments (1)
README.md (1)

9-9: Confirm badge renders and links correctly
Please preview the updated README to ensure that the OpenSSF Best Practices Badge:

  • Loads the SVG image via the [OpenSSF Best Practices Badge] reference.
  • Links to the correct page at https://www.bestpractices.dev/projects/9963.

@MaxymVlasov MaxymVlasov added wip Indicates that an issue or PR is actively being worked on by a contributor. and removed stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 25, 2025
@MaxymVlasov MaxymVlasov removed the wip Indicates that an issue or PR is actively being worked on by a contributor. label May 15, 2025
@MaxymVlasov MaxymVlasov marked this pull request as ready for review May 15, 2025 21:19
@MaxymVlasov MaxymVlasov requested a review from antonbabenko as a code owner May 15, 2025 21:19
@MaxymVlasov MaxymVlasov requested a review from yermulnik May 15, 2025 22:50
Copy link
Collaborator

@yermulnik yermulnik left a comment

Choose a reason for hiding this comment

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

LGTM.
A side note: I'm wondering why the links and their references (marked with red arrows) are placed not nearby but are separated by an block of text (enclosed in a red rectangle)? 🤔
image

@MaxymVlasov
Copy link
Collaborator Author

LGTM. A side note: I'm wondering why the links and their references (marked with red arrows) are placed not nearby but are separated by an block of text (enclosed in a red rectangle)? 🤔 image

In theory, it makes sense to move these links right to the bottom of file, but I thought that it will be too much, so I left them in the end of "intro" block

@MaxymVlasov MaxymVlasov merged commit 86557c2 into master May 16, 2025
47 checks passed
@MaxymVlasov MaxymVlasov deleted the MaxymVlasov-patch-1 branch May 16, 2025 17:29
@yermulnik
Copy link
Collaborator

LGTM. A side note: I'm wondering why the links and their references (marked with red arrows) are placed not nearby but are separated by an block of text (enclosed in a red rectangle)? 🤔

In theory, it makes sense to move these links right to the bottom of file, but I thought that it will be too much, so I left them in the end of "intro" block

Why don't we put them right under where they are referred at? As in move the red rectangle down under the list of links to images for banners?

@yermulnik
Copy link
Collaborator

Do we really need to split banners from their images?
That should just work w/o quirks like this: Stand With Ukraine

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

@MaxymVlasov
Copy link
Collaborator Author

Readability matters, even here

@yermulnik
Copy link
Collaborator

Readability matters, even here

Well, while I do agree with the statement, the current placement of the related links (separated by an arbitrary block of data) and the approach as a whole (separation of links and images) isn't readable to me 🤷🏻

@antonbabenko
Copy link
Owner

This PR is included in version 1.99.1 🎉

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