build: housekeeping

[konradmichalik]

Summary by CodeRabbit

• Chores

  • Added a CODEOWNERS file to specify repository ownership and review responsibilities.

• Documentation

  • Updated the README to display a License badge.
  • Added a note clarifying the intended audience for the project.
  • Renamed the "Credits" section to "Acknowledgements".

[coderabbitai]

Walkthrough

A CODEOWNERS file was introduced to assign repository ownership, and the README was updated to change badges, clarify intended usage, and rename the credits section to acknowledgements. No changes were made to code or public interfaces.

Changes

File(s)	Change Summary
CODEOWNERS	Added file specifying repository ownership for all files to a designated user.
README.md	Updated badge, added usage clarification note, and renamed "Credits" to "Acknowledgements".

Estimated code review effort

1 (<10 minutes)

Poem

A CODEOWNERS file, a README anew,
Badges now sparkle, intentions in view.
Ownership clear as a carrot in spring,
Acknowledgements bloom, what joy they bring!
With every commit, our warren takes pride—
🥕🐇 Code and community, side by side.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)

12-13: Grammar: “These recipes” instead of “This recipes”

Minor wording fix for correct plural agreement.

-This recipes are mainly used in [move:elevator](https://www.move-elevator.de/) projects. It is not meant to be used anywhere else.
+These recipes are mainly used in [move:elevator](https://www.move-elevator.de/) projects and are not intended for general use.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 020fca5 and e4b363d.

📒 Files selected for processing (2)

• CODEOWNERS (1 hunks)
• README.md (2 hunks)

🔇 Additional comments (1)

README.md (1)

6-6: Badge link looks good

Switching to a license badge is clear and correct; no issues spotted.

[coderabbitai]

⚠️ Potential issue

CODEOWNERS entry uses an e-mail address; GitHub will ignore it

GitHub only recognises usernames (@username) or team slugs (@org/team) in CODEOWNERS.
[email protected] will silently be treated as plain text and no code-owner will be assigned.

-* [email protected]
+* @km          # replace with the correct GitHub username or team

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	* [email protected]
	* @km # replace with the correct GitHub username or team

🤖 Prompt for AI Agents

In the CODEOWNERS file at line 1, replace the email address
"[email protected]" with the correct GitHub username or team slug format, such
as "@username" or "@org/team", to ensure GitHub properly assigns the code owner.