Fix README file name

[mikhail-iurkov]

Description

Issue: #241

Checklist

• Tests (if applicable)
• Documentation (if applicable)
• Changelog stub (or use conventional commit messages)

Summary by CodeRabbit

• Chores
  • Updated project description format from Markdown to reStructuredText in the configuration file.
• New Features
  • Version updated to 2.0.1, reflecting a new release.
• Bug Fixes
  • Fixed a metadata error by correcting the README file name in the project configuration.

[coderabbitai]

Walkthrough

The pull request introduces several updates across multiple files. The setup.cfg file has been modified to change the description-file entry from README.md to README.rst, reflecting a format transition for the project documentation. Additionally, the version number in migro/__init__.py has been incremented from 2.0.0 to 2.0.1, and a new entry has been added to CHANGELOG.md to document this version change along with a fix for a metadata error.

Changes

File	Change Summary
setup.cfg	Updated description-file from README.md to README.rst
CHANGELOG.md	Added version 2.0.1, dated September 25, 2024, for a metadata error fix
migro/init.py	Updated version from 2.0.0 to 2.0.1

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Setup
    User->>Setup: Request project description
    Setup->>Setup: Read description from README.rst
    Setup-->>User: Provide project description

Loading

Poem

In the meadow where bunnies play,
A change was made, hip-hip-hooray!
From Markdown to reStructuredText,
Our README shines, oh what a quest!
Hopping with joy, we celebrate,
A clearer tale for all to relate! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bc8507e and 8eaecc7.

📒 Files selected for processing (1)

• CHANGELOG.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• CHANGELOG.md

---

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

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

[dmitry-mukhin]

👍

[dmitry-mukhin]

actually, lets prepare the next patch release right away

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

CHANGELOG.md (1)

9-12: LGTM! Consider adding more details to the changelog entry.

The new changelog entry for version 2.0.1 is correctly formatted and includes the essential information:

• Version number (2.0.1) follows semantic versioning principles.
• Date (2024-09-25) is consistent with the current timeframe.
• The fix is properly categorized under "Fixed" and references the correct issue (Migro fails to install #241).

To improve clarity, consider adding a brief description of the metadata error that was fixed. For example:

 ## [2.0.1] - 2024-09-25

 ### Fixed
-Metadata error (#241)
+Metadata error: Corrected README file name in project configuration (#241)

This additional detail would provide more context for users and developers reviewing the changelog in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f69aa29 and bc8507e.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• migro/init.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• migro/init.py