This repository was archived by the owner on Jul 10, 2025. It is now read-only.
Updated readme to reflect AlbumentationsX#2570
Merged
Conversation
Contributor
Reviewer's GuideThis PR overhauls the README to announce the end of maintenance for Albumentations and direct users to the new AlbumentationsX successor—including migration instructions, licensing details and updated support links—while pruning outdated content and reorganizing sponsorship sections, plus a minor update to the rules metadata file. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the main README to declare Albumentations end-of-life, introduce the new AlbumentationsX successor, and refresh installation/docs links; it also adds a minor testing guideline in the project rules.
- Mark repository as unmaintained and point users to AlbumentationsX
- Provide migration steps, dual‐license warning, and updated links
- Append a rule in
.cursor/rulesabout placing new tests in thetestsfolder
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds “no longer maintained” notice, introduces AlbumentationsX and migration guide; updates links and reorders content |
| .cursor/rules/albumentations-rules.mdc | Adds a rule advising new tests be created in the tests folder |
Comments suppressed due to low confidence (2)
README.md:46
- The nested list under 'Dual licensed:' currently uses '- -', which can break markdown rendering. Use two spaces before the dash (i.e. ' - AGPL-3.0: ...') to maintain proper list nesting.
- **AGPL-3.0**: Free ONLY for projects licensed under AGPL-3.0 (not compatible with MIT, Apache, BSD, etc.)
README.md:36
- [nitpick] This 'Best for:' line appears unindented under option 1. Indent it to align with the numbered list item so it’s rendered as a sub‐point of '1. Continue Using Albumentations'.
**Best for:** Projects that work fine with the current version and don't need updates
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Update README to mark Albumentations as unmaintained and guide users toward the new AlbumentationsX successor with licensing details, migration instructions, and refreshed links.
Documentation: