-
Notifications
You must be signed in to change notification settings - Fork 0
chore: prepare release v0.1.1 #20
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <!-- BEGIN:nextjs-agent-rules --> | ||
|
|
||
| # This is NOT the Next.js you know | ||
|
|
||
| This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` before writing any code. Heed deprecation notices. | ||
|
|
||
| <!-- END:nextjs-agent-rules --> |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,11 +58,11 @@ By participating, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). | |
|
|
||
| ### Prerequisites | ||
|
|
||
| | Tool | Version | | ||
| |---|---| | ||
| | Tool | Version | | ||
| | ------- | ------------ | | ||
| | Node.js | `>= 22.15.1` | | ||
| | pnpm | `>= 10.13.1` | | ||
| | Git | Latest | | ||
| | pnpm | `>= 10.13.1` | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win Update pnpm prerequisite version to match Shows 🤖 Prompt for AI Agents |
||
| | Git | Latest | | ||
|
|
||
| ### Recommended Setup | ||
|
|
||
|
|
@@ -135,14 +135,14 @@ For **significant changes** (new features, breaking changes, architectural decis | |
|
|
||
| All branches must follow this naming convention: | ||
|
|
||
| | Type | Pattern | Example | | ||
| |---|---|---| | ||
| | Feature | `feature/<short-description>` | `feature/user-auth` | | ||
| | Bug fix | `fix/<short-description>` | `fix/button-focus-ring` | | ||
| | Documentation | `docs/<short-description>` | `docs/api-reference` | | ||
| | Chore | `chore/<short-description>` | `chore/update-deps` | | ||
| | Hotfix | `hotfix/<short-description>` | `hotfix/critical-xss` | | ||
| | Release | `release/<version>` | `release/1.2.0` | | ||
| | Type | Pattern | Example | | ||
| | ------------- | ----------------------------- | ----------------------- | | ||
| | Feature | `feature/<short-description>` | `feature/user-auth` | | ||
| | Bug fix | `fix/<short-description>` | `fix/button-focus-ring` | | ||
| | Documentation | `docs/<short-description>` | `docs/api-reference` | | ||
| | Chore | `chore/<short-description>` | `chore/update-deps` | | ||
| | Hotfix | `hotfix/<short-description>` | `hotfix/critical-xss` | | ||
| | Release | `release/<version>` | `release/1.2.0` | | ||
|
|
||
| **Rules:** | ||
|
|
||
|
|
@@ -178,19 +178,19 @@ This project strictly follows [Conventional Commits](https://www.conventionalcom | |
|
|
||
| ### Types | ||
|
|
||
| | Type | When to Use | | ||
| |---|---| | ||
| | `feat` | Adds a new feature (triggers minor version bump) | | ||
| | `fix` | Fixes a bug (triggers patch version bump) | | ||
| | `docs` | Documentation only changes | | ||
| | `style` | Formatting, whitespace — no logic change | | ||
| | Type | When to Use | | ||
| | ---------- | ------------------------------------------------------- | | ||
| | `feat` | Adds a new feature (triggers minor version bump) | | ||
| | `fix` | Fixes a bug (triggers patch version bump) | | ||
| | `docs` | Documentation only changes | | ||
| | `style` | Formatting, whitespace — no logic change | | ||
| | `refactor` | Code change that neither fixes a bug nor adds a feature | | ||
| | `perf` | Improves performance | | ||
| | `test` | Adding or updating tests | | ||
| | `build` | Changes to build system or dependencies | | ||
| | `ci` | Changes to CI configuration | | ||
| | `chore` | Other changes that don't modify src or test files | | ||
| | `revert` | Reverts a previous commit | | ||
| | `perf` | Improves performance | | ||
| | `test` | Adding or updating tests | | ||
| | `build` | Changes to build system or dependencies | | ||
| | `ci` | Changes to CI configuration | | ||
| | `chore` | Other changes that don't modify src or test files | | ||
| | `revert` | Reverts a previous commit | | ||
|
|
||
| ### Scopes | ||
|
|
||
|
|
@@ -257,11 +257,11 @@ Keep PRs focused and small. A PR that touches fewer files is easier and faster t | |
|
|
||
| ### Targeting the Correct Branch | ||
|
|
||
| | Change Type | Target Branch | | ||
| |---|---| | ||
| | Features, fixes, docs | `develop` | | ||
| | Change Type | Target Branch | | ||
| | --------------------------- | --------------- | | ||
| | Features, fixes, docs | `develop` | | ||
| | Critical production patches | `main` (hotfix) | | ||
| | Release preparation | `develop` | | ||
| | Release preparation | `develop` | | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -283,14 +283,14 @@ Keep PRs focused and small. A PR that touches fewer files is easier and faster t | |
|
|
||
| ### Naming | ||
|
|
||
| | Entity | Convention | Example | | ||
| |---|---|---| | ||
| | Files | `kebab-case` | `user-profile.tsx` | | ||
| | Components | `PascalCase` | `UserProfile` | | ||
| | Hooks | `camelCase` with `use` prefix | `useUserProfile` | | ||
| | Utilities | `camelCase` | `formatDate` | | ||
| | Constants | `UPPER_SNAKE_CASE` | `MAX_RETRY_COUNT` | | ||
| | Types/Interfaces | `PascalCase` | `UserProfileProps` | | ||
| | Entity | Convention | Example | | ||
| | ---------------- | ----------------------------- | ------------------ | | ||
| | Files | `kebab-case` | `user-profile.tsx` | | ||
| | Components | `PascalCase` | `UserProfile` | | ||
| | Hooks | `camelCase` with `use` prefix | `useUserProfile` | | ||
| | Utilities | `camelCase` | `formatDate` | | ||
| | Constants | `UPPER_SNAKE_CASE` | `MAX_RETRY_COUNT` | | ||
| | Types/Interfaces | `PascalCase` | `UserProfileProps` | | ||
|
|
||
| ### Formatting | ||
|
|
||
|
|
@@ -329,13 +329,14 @@ pnpm test:coverage # With coverage report | |
|
|
||
| Releases are managed by maintainers following [Semantic Versioning](https://semver.org): | ||
|
|
||
| | Change | Version Bump | | ||
| |---|---| | ||
| | `BREAKING CHANGE` | Major (`1.0.0` → `2.0.0`) | | ||
| | `feat` | Minor (`1.0.0` → `1.1.0`) | | ||
| | Change | Version Bump | | ||
| | --------------------- | ------------------------- | | ||
| | `BREAKING CHANGE` | Major (`1.0.0` → `2.0.0`) | | ||
| | `feat` | Minor (`1.0.0` → `1.1.0`) | | ||
| | `fix`, `perf`, others | Patch (`1.0.0` → `1.0.1`) | | ||
|
|
||
| Releases are created by: | ||
|
|
||
| 1. Merging `develop` into `main` | ||
| 2. Pushing a version tag (`v1.2.3`) | ||
| 3. The release workflow automatically creates the GitHub Release with generated notes | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix horizontal rule style for markdownlint compliance.
The
***rule violates MD035; the rest of this file uses---. Align to---to prevent lint warnings and maintain consistency.📝 Committable suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 32-32: Horizontal rule style
Expected: ---; Actual: ***
(MD035, hr-style)
🤖 Prompt for AI Agents
Source: Linters/SAST tools