@codedrifters/configulator 0.0.170 → 0.0.172
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.js +23 -17
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +23 -17
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
package/lib/index.mjs
CHANGED
|
@@ -592,7 +592,7 @@ var baseBundle = {
|
|
|
592
592
|
},
|
|
593
593
|
{
|
|
594
594
|
name: "branch-naming-conventions",
|
|
595
|
-
description: "Branch format (type/
|
|
595
|
+
description: "Branch format (type/issue-description), create-on-GitHub-then-fetch workflow",
|
|
596
596
|
scope: AGENT_RULE_SCOPE.ALWAYS,
|
|
597
597
|
content: [
|
|
598
598
|
"# Branch Naming Conventions",
|
|
@@ -600,19 +600,19 @@ var baseBundle = {
|
|
|
600
600
|
"## Format",
|
|
601
601
|
"",
|
|
602
602
|
"```",
|
|
603
|
-
"<type
|
|
603
|
+
"<type>/<issue-number>-<issue-slug>",
|
|
604
604
|
"```",
|
|
605
605
|
"",
|
|
606
606
|
"- **type** (required): One of `feat`, `fix`, `docs`, `chore`, `refactor`, `release`, `hotfix`",
|
|
607
|
-
"- **issue** (
|
|
608
|
-
"- **
|
|
607
|
+
"- **issue-number** (required): The GitHub issue number (e.g., `25`)",
|
|
608
|
+
"- **issue-slug** (required): Short, lowercase, kebab-case summary derived from the issue title",
|
|
609
609
|
"",
|
|
610
610
|
"## Examples",
|
|
611
611
|
"",
|
|
612
612
|
"- `feat/25-add-cursor-rules`",
|
|
613
613
|
"- `fix/23-rename-cursor-rules-mdc`",
|
|
614
|
-
"- `chore/upgrade-eslint`",
|
|
615
|
-
"- `docs/update-readme`"
|
|
614
|
+
"- `chore/42-upgrade-eslint`",
|
|
615
|
+
"- `docs/18-update-readme`"
|
|
616
616
|
].join("\n"),
|
|
617
617
|
tags: ["workflow"]
|
|
618
618
|
},
|
|
@@ -691,14 +691,14 @@ var githubWorkflowBundle = {
|
|
|
691
691
|
" - `chore:` / `refactor:` \u2192 `chore/`",
|
|
692
692
|
" - `test:` \u2192 `test/`",
|
|
693
693
|
" - No prefix \u2192 `feat/`",
|
|
694
|
-
"4. **Create a branch** following the naming convention: `<type>/<
|
|
694
|
+
"4. **Create a branch** following the naming convention: `<type>/<issue-number>-<issue-slug>` (e.g., `feat/42-add-login`)",
|
|
695
695
|
"5. **Checkout the branch** locally",
|
|
696
696
|
"6. **Link the branch to the issue** by posting a comment: `gh issue comment <number> --body 'Branch: \\`<branch-name>\\`'`",
|
|
697
|
-
"7. **
|
|
697
|
+
"7. **Create an implementation plan** \u2014 analyze the issue requirements, explore the relevant codebase, and present a plan for the user to approve before starting any implementation",
|
|
698
698
|
"",
|
|
699
699
|
"### Important",
|
|
700
700
|
"",
|
|
701
|
-
"- Never begin implementation without
|
|
701
|
+
"- Never begin implementation without the user approving the plan",
|
|
702
702
|
"- If the issue title has no conventional prefix, default to `feat/`",
|
|
703
703
|
"- Keep the slug short (3-5 words max, kebab-case)"
|
|
704
704
|
].join("\n"),
|
|
@@ -716,17 +716,23 @@ var githubWorkflowBundle = {
|
|
|
716
716
|
"When the user says **open a PR** (or similar), follow these steps exactly:",
|
|
717
717
|
"",
|
|
718
718
|
"1. **Check for uncommitted changes** \u2014 if any exist, commit them with a conventional commit message",
|
|
719
|
-
"2. **
|
|
720
|
-
"3. **
|
|
719
|
+
"2. **Pull and rebase from the default branch** \u2014 run `git pull origin {{repository.defaultBranch}} --rebase` to incorporate the latest changes and resolve any conflicts before pushing",
|
|
720
|
+
"3. **Push the branch** to origin: `git push -u origin <branch>`",
|
|
721
|
+
"4. **Create the PR** using `gh pr create`:",
|
|
721
722
|
" - **Title**: use a conventional commit style title (e.g., `feat(scope): short description`)",
|
|
722
723
|
" - **Body**: include `Closes #<issue-number>` (derived from the branch name) and a brief summary of changes",
|
|
723
|
-
"
|
|
724
|
+
"5. **Enable auto-merge with squash** \u2014 use `gh pr merge --auto --squash` with the merge commit message:",
|
|
724
725
|
"",
|
|
725
726
|
"```",
|
|
726
|
-
"
|
|
727
|
-
"
|
|
727
|
+
"gh pr merge --auto --squash --subject '<conventional-commit-title>' --body '<extended-description>'",
|
|
728
|
+
"```",
|
|
729
|
+
"",
|
|
730
|
+
"The merge commit message should follow this format:",
|
|
731
|
+
"",
|
|
732
|
+
"```",
|
|
733
|
+
"Subject: <conventional-commit-title>",
|
|
728
734
|
"",
|
|
729
|
-
"
|
|
735
|
+
"Body:",
|
|
730
736
|
"- Bullet points summarizing the changes",
|
|
731
737
|
"- Closes #<issue-number>",
|
|
732
738
|
"```",
|
|
@@ -748,9 +754,9 @@ var githubWorkflowBundle = {
|
|
|
748
754
|
"",
|
|
749
755
|
"### Important",
|
|
750
756
|
"",
|
|
751
|
-
"- Always derive the issue number from the branch name (e.g., `feat/add-login
|
|
757
|
+
"- Always derive the issue number from the branch name (e.g., `feat/42-add-login` \u2192 `#42`)",
|
|
752
758
|
"- Use conventional commit format for the PR title",
|
|
753
|
-
"-
|
|
759
|
+
"- Always enable auto-merge with squash \u2014 do not merge manually"
|
|
754
760
|
].join("\n"),
|
|
755
761
|
tags: ["workflow"]
|
|
756
762
|
}
|