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

feat: add license #13

Merged
merged 1 commit into from
Aug 6, 2024
Merged

feat: add license #13

merged 1 commit into from
Aug 6, 2024

Conversation

joostlek
Copy link
Collaborator

@joostlek joostlek commented Aug 6, 2024

fixes #4

This PR relicenses the code with a MIT license to make the code OSI-approved.

Summary by CodeRabbit

  • New Features
    • Added a LICENSE.md file detailing the MIT License terms, enhancing user awareness of rights and responsibilities.
    • Updated project metadata with the addition of a license specification in the pyproject.toml, clarifying the software's usage and distribution terms.

Copy link

coderabbitai bot commented Aug 6, 2024

Walkthrough

This update introduces the MIT License to the project, providing clear permissions for users regarding usage, modification, and distribution. A new LICENSE.md file has been created to outline these terms, and the pyproject.toml file has been updated to specify the project's licensing information. These changes enhance project documentation and compliance with open-source practices, ensuring users understand their rights and responsibilities.

Changes

Files Change Summary
LICENSE.md Added the MIT License text detailing user rights and disclaimers.
pyproject.toml Added license = "MIT" to specify the project's license.

Poem

In the garden where code does play,
A license blooms, brightening the day.
With MIT's charm, open and free,
Users can dance in a code jubilee!
Hops and skips, let the software flow,
Together we share, together we grow! 🐇✨


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 Configuration 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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d1a2213 and dc36a0c.

Files selected for processing (2)
  • LICENSE.md (1 hunks)
  • pyproject.toml (1 hunks)
Files skipped from review due to trivial changes (2)
  • LICENSE.md
  • pyproject.toml

@joostlek joostlek requested a review from kk7ds August 6, 2024 13:05
Copy link
Collaborator

@kk7ds kk7ds left a comment

Choose a reason for hiding this comment

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

I'm the original author of this code and I gave my permission MIT license it.

@joostlek joostlek merged commit 15085ac into main Aug 6, 2024
7 checks passed
@joostlek joostlek deleted the license branch August 6, 2024 13:52
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.

Please select a license for redistribution.
2 participants