Skip to content
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

doc(other): add Fosso license scan badge #325

Merged
merged 2 commits into from
Jul 14, 2024

Conversation

KeisukeYamashita
Copy link
Owner

@KeisukeYamashita KeisukeYamashita commented Jul 14, 2024

Why

To show that this project checks licenses and we don't violate any IPs.

Summary by CodeRabbit

  • Documentation
    • Added a FOSSA shield badge to the README file for improved visibility of license compliance.

fossabot and others added 2 commits July 14, 2024 07:50
@KeisukeYamashita KeisukeYamashita self-assigned this Jul 14, 2024
Copy link

coderabbitai bot commented Jul 14, 2024

Walkthrough

A new FOSSA shield badge link was added to the README.md file. This inclusion enhances the project's documentation by providing users with immediate insight into the project's license compliance status. No changes were made to the declarations of exported or public entities.

Changes

Files Change Summary
README.md Added a new shield badge link for FOSSA.

Poem

🐇 In the README, bright and clear,
A badge of FOSSA does appear.
With a hop and a leap, compliance we cheer,
Our project shines with no fear.
Shielded by the badge, we steer,
Toward open source, sincere. 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@KeisukeYamashita KeisukeYamashita changed the title doc: add Fosso license scan badge doc(other): add Fosso license scan badge Jul 14, 2024
@KeisukeYamashita KeisukeYamashita merged commit f0e1b38 into main Jul 14, 2024
22 of 27 checks passed
@KeisukeYamashita KeisukeYamashita deleted the add-license-scan-badge branch July 14, 2024 10:57
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

Outside diff range, codebase verification and nitpick comments (1)
README.md (1)

16-16: Add alternate text to the FOSSA license scan badge.

For better accessibility and to follow best practices, add alternate text to the image.

- [![](https://app.fossa.com/api/projects/git%2Bgithub.com%2FKeisukeYamashita%2Fcommitlint-rs.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FKeisukeYamashita%2Fcommitlint-rs?ref=badge_shield)
+ [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FKeisukeYamashita%2Fcommitlint-rs.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FKeisukeYamashita%2Fcommitlint-rs?ref=badge_shield)
Tools
Markdownlint

16-16: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a135ca and 484bb2b.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
Markdownlint
README.md

16-16: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

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