Skip to content

Conversation

melonora
Copy link
Contributor

@melonora melonora commented Jul 22, 2025

Change note in preparation for making the repo standalone.

Summary by Sourcery

Update the project README to reflect that the repository has transitioned from a fork to a standalone project and clarify its release status on PyPI.

Documentation:

  • Adjust wording to indicate the repository was originally a fork but is now a standalone project
  • Update release note to state the repository isn’t released yet and plans to secure the PyPI name and make additional changes before release

Copy link

sourcery-ai bot commented Jul 22, 2025

Reviewer's Guide

This PR revises the README’s introductory note to reflect that the project has transitioned from a fork to a standalone repository and updates the release status details.

File-Level Changes

Change Details Files
Clarify repository origin and standalone status
  • Changed wording from present to past tense for original fork statement
  • Added sentence indicating transition to a standalone repository
  • Fixed a typo in “initially”
README.md
Update release note for upcoming PyPI publication
  • Rephrased that the repository is not yet released
  • Mentioned ongoing efforts to secure the PyPI name and perform additional changes before release
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @melonora - I've reviewed your changes - here's some feedback:

  • Fix the typo 'intially' in the README to 'initially'.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Fix the typo 'intially' in the README to 'initially'.

## Individual Comments

### Comment 1
<location> `README.md:4` </location>
<code_context>
 work of the developer on this repo. That being said, sadly the state on main has been the case that the code was 
-deleted and there has been no development for a while. Therefore, we have decided to fork the repository and 
-continue development here, where the community is better able to contribute to and maintain the project.
+deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and 
+continue development here, where the community is better able to contribute to and maintain the project. We now changed
+it into a standalone repository.
</code_context>

<issue_to_address>
Typo: 'intially' should be 'initially'.

Please update 'intially' to 'initially'.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and 
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.
=======
deleted and there has been no development for a while. Therefore, we initially decided to fork the repository and 
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `README.md:8` </location>
<code_context>
+it into a standalone repository.

-Note, the fork currently is not released. We are trying to get the name `xarray-dataclasses` on PyPi.
+Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPi and make some 
+additional changes before release.

</code_context>

<issue_to_address>
Correct capitalization: 'PyPi' should be 'PyPI'.

Please update 'PyPi' to 'PyPI' for accuracy.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPi and make some 
additional changes before release.
=======
Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPI and make some 
additional changes before release.
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +4 to +6
deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.
Copy link

Choose a reason for hiding this comment

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

issue (typo): Typo: 'intially' should be 'initially'.

Please update 'intially' to 'initially'.

Suggested change
deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.
deleted and there has been no development for a while. Therefore, we initially decided to fork the repository and
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.

Comment on lines +8 to +9
Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPi and make some
additional changes before release.
Copy link

Choose a reason for hiding this comment

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

issue (typo): Correct capitalization: 'PyPi' should be 'PyPI'.

Please update 'PyPi' to 'PyPI' for accuracy.

Suggested change
Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPi and make some
additional changes before release.
Note, the repository is not yet released. We are trying to get the name `xarray-dataclasses` on PyPI and make some
additional changes before release.

@melonora melonora merged commit 33c512f into main Jul 22, 2025
5 checks passed
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.

1 participant