@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.js
CHANGED
|
@@ -643,7 +643,7 @@ var baseBundle = {
|
|
|
643
643
|
},
|
|
644
644
|
{
|
|
645
645
|
name: "branch-naming-conventions",
|
|
646
|
-
description: "Branch format (type/
|
|
646
|
+
description: "Branch format (type/issue-description), create-on-GitHub-then-fetch workflow",
|
|
647
647
|
scope: AGENT_RULE_SCOPE.ALWAYS,
|
|
648
648
|
content: [
|
|
649
649
|
"# Branch Naming Conventions",
|
|
@@ -651,19 +651,19 @@ var baseBundle = {
|
|
|
651
651
|
"## Format",
|
|
652
652
|
"",
|
|
653
653
|
"```",
|
|
654
|
-
"<type
|
|
654
|
+
"<type>/<issue-number>-<issue-slug>",
|
|
655
655
|
"```",
|
|
656
656
|
"",
|
|
657
657
|
"- **type** (required): One of `feat`, `fix`, `docs`, `chore`, `refactor`, `release`, `hotfix`",
|
|
658
|
-
"- **issue** (
|
|
659
|
-
"- **
|
|
658
|
+
"- **issue-number** (required): The GitHub issue number (e.g., `25`)",
|
|
659
|
+
"- **issue-slug** (required): Short, lowercase, kebab-case summary derived from the issue title",
|
|
660
660
|
"",
|
|
661
661
|
"## Examples",
|
|
662
662
|
"",
|
|
663
663
|
"- `feat/25-add-cursor-rules`",
|
|
664
664
|
"- `fix/23-rename-cursor-rules-mdc`",
|
|
665
|
-
"- `chore/upgrade-eslint`",
|
|
666
|
-
"- `docs/update-readme`"
|
|
665
|
+
"- `chore/42-upgrade-eslint`",
|
|
666
|
+
"- `docs/18-update-readme`"
|
|
667
667
|
].join("\n"),
|
|
668
668
|
tags: ["workflow"]
|
|
669
669
|
},
|
|
@@ -742,14 +742,14 @@ var githubWorkflowBundle = {
|
|
|
742
742
|
" - `chore:` / `refactor:` \u2192 `chore/`",
|
|
743
743
|
" - `test:` \u2192 `test/`",
|
|
744
744
|
" - No prefix \u2192 `feat/`",
|
|
745
|
-
"4. **Create a branch** following the naming convention: `<type>/<
|
|
745
|
+
"4. **Create a branch** following the naming convention: `<type>/<issue-number>-<issue-slug>` (e.g., `feat/42-add-login`)",
|
|
746
746
|
"5. **Checkout the branch** locally",
|
|
747
747
|
"6. **Link the branch to the issue** by posting a comment: `gh issue comment <number> --body 'Branch: \\`<branch-name>\\`'`",
|
|
748
|
-
"7. **
|
|
748
|
+
"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",
|
|
749
749
|
"",
|
|
750
750
|
"### Important",
|
|
751
751
|
"",
|
|
752
|
-
"- Never begin implementation without
|
|
752
|
+
"- Never begin implementation without the user approving the plan",
|
|
753
753
|
"- If the issue title has no conventional prefix, default to `feat/`",
|
|
754
754
|
"- Keep the slug short (3-5 words max, kebab-case)"
|
|
755
755
|
].join("\n"),
|
|
@@ -767,17 +767,23 @@ var githubWorkflowBundle = {
|
|
|
767
767
|
"When the user says **open a PR** (or similar), follow these steps exactly:",
|
|
768
768
|
"",
|
|
769
769
|
"1. **Check for uncommitted changes** \u2014 if any exist, commit them with a conventional commit message",
|
|
770
|
-
"2. **
|
|
771
|
-
"3. **
|
|
770
|
+
"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",
|
|
771
|
+
"3. **Push the branch** to origin: `git push -u origin <branch>`",
|
|
772
|
+
"4. **Create the PR** using `gh pr create`:",
|
|
772
773
|
" - **Title**: use a conventional commit style title (e.g., `feat(scope): short description`)",
|
|
773
774
|
" - **Body**: include `Closes #<issue-number>` (derived from the branch name) and a brief summary of changes",
|
|
774
|
-
"
|
|
775
|
+
"5. **Enable auto-merge with squash** \u2014 use `gh pr merge --auto --squash` with the merge commit message:",
|
|
775
776
|
"",
|
|
776
777
|
"```",
|
|
777
|
-
"
|
|
778
|
-
"
|
|
778
|
+
"gh pr merge --auto --squash --subject '<conventional-commit-title>' --body '<extended-description>'",
|
|
779
|
+
"```",
|
|
780
|
+
"",
|
|
781
|
+
"The merge commit message should follow this format:",
|
|
782
|
+
"",
|
|
783
|
+
"```",
|
|
784
|
+
"Subject: <conventional-commit-title>",
|
|
779
785
|
"",
|
|
780
|
-
"
|
|
786
|
+
"Body:",
|
|
781
787
|
"- Bullet points summarizing the changes",
|
|
782
788
|
"- Closes #<issue-number>",
|
|
783
789
|
"```",
|
|
@@ -799,9 +805,9 @@ var githubWorkflowBundle = {
|
|
|
799
805
|
"",
|
|
800
806
|
"### Important",
|
|
801
807
|
"",
|
|
802
|
-
"- Always derive the issue number from the branch name (e.g., `feat/add-login
|
|
808
|
+
"- Always derive the issue number from the branch name (e.g., `feat/42-add-login` \u2192 `#42`)",
|
|
803
809
|
"- Use conventional commit format for the PR title",
|
|
804
|
-
"-
|
|
810
|
+
"- Always enable auto-merge with squash \u2014 do not merge manually"
|
|
805
811
|
].join("\n"),
|
|
806
812
|
tags: ["workflow"]
|
|
807
813
|
}
|