Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

MaxymVlasov
Copy link
Collaborator

@MaxymVlasov MaxymVlasov commented Jan 26, 2025

Previously I filled mostly all question, except last section about SAST and Fuzzing.

SAST will be covered by CodeQL and zizmor later.

We can wait with merge of this badge till it will not become "greener"

Relates #712

Copy link

coderabbitai bot commented Jan 26, 2025

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added an OpenSSF Best Practices badge to the README, linking to the project page.

Summary by CodeRabbit

  • Documentation
    • Updated project documentation with a new badge indicating adherence to open-source security best practices.
    • Included updated references to ensure clear communication of compliance.

Walkthrough

The pull request introduces an OpenSSF Best Practices badge to the README.md file, indicating compliance with open-source software security standards. This badge links to the OpenSSF Best Practices project and is accompanied by a reference in the badge list at the document's bottom. Additionally, two blank lines were added, which do not impact the document's content or functionality.

Changes

File Change Summary
README.md Added OpenSSF Best Practices badge with link to project's best practices profile; added badge reference and two blank lines.

Possibly related PRs

  • chore: Add OSSF badge #787: The changes in this PR also involve adding a badge to the README.md file, specifically for the OpenSSF Scorecard, which is related to open-source software security, similar to the OpenSSF Best Practices badge added in the main PR.

Suggested reviewers

  • yermulnik

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wip Indicates that an issue or PR is actively being worked on by a contributor.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants