Skip to content

Add deprecation notice to README #28

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.

Sign up for GitHub

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

Merged
HeavyMedl merged 1 commit into from
Nov 4, 2025
Merged

Add deprecation notice to README #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Create package

> ⚠️ **Deprecation Notice**
>
> This package is **deprecated** and will no longer receive updates or support.
>
Comment on lines +5 to +6
Copy link

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

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

[nitpick] The deprecation notice states the package is deprecated but does not provide actionable guidance (e.g., recommended replacement, last supported version, deprecation date, or migration steps). Consider adding one or more of these so consumers know how to proceed.

Suggested change
> This package is **deprecated** and will no longer receive updates or support.
>
> This package is **deprecated** and will no longer receive updates or support. The last supported version is `@rei/create-package@2.3.1`. Deprecation effective as of June 2024.
>
> **Recommended replacement:** Please use [create-vue](https://github.com/vuejs/create-vue) for Vue projects, or refer to the [REI NPM package guidelines](https://www.rei.com/) for up-to-date scaffolding methods. For migration steps, see [MIGRATION.md](./MIGRATION.md) (if available) or consult your team lead.

Copilot uses AI. Check for mistakes.

The officially supported way to create NPM packages at [REI](https://www.rei.com/).

With `@rei/create-package`, you can quickly scaffold:
Expand Down