make-change-file
Make Change File
Overview
Write release notes that match this repository's .changes conventions. Use it for both new change files and edits to existing unpublished ones.
Workflow
- Read the package's
package.json,.changes/directory, and any relevant PR diff or commit range before writing anything. - Check whether an unpublished change file already exists for the same work. If it does, update it in place instead of creating a duplicate note.
- Choose the bump type from the package version and the user-facing impact.
- Write concise, user-facing release notes that describe shipped behavior, APIs, or exports.
- Run
pnpm changes:previewto verify the rendered changelog output. - Run
pnpm run lintbefore finishing.
Naming
More from remix-run/remix
write-readme
Write or rewrite package README files in the style used by the Remix repository. Use when drafting a new package README, revising an existing README, or reviewing README structure, examples, installation instructions, and section ordering for Remix packages.
28add-package
Create or align a package in the Remix monorepo to match existing package conventions. Use when adding a brand new package under packages/, or when fixing an existing package's structure, test setup, TypeScript/build config, code style, and README layout to match the rest of Remix 3.
9remix-ui
Build the UI of a Remix app. Use when creating pages, layouts, client entries, interactions, stateful UI, navigation, hydration, styling, animations, reusable mixins, or UI tests.
7remix-project-layout
Describe the ideal layout of a Remix application, including canonical directories, route ownership, naming conventions, and file locations on disk. When asked to bootstrap that layout in a new directory, run the bundled TypeScript script.
6write-api-docs
Write or audit public API docs for Remix packages. Use when adding or tightening JSDoc on exported functions, classes, interfaces, type aliases, or option objects.
5publish-placeholder-package
Publish a placeholder npm package at version 0.0.0 so package names are reserved and npm OIDC permissions can be configured before CI publishing. Use when creating a brand-new package that is not ready for full release.
5