Skip to content

Commit a58c8cb

Browse files
committed
feat: enhance long description and steps for git request-pull in toc-source.json to improve clarity and usability
1 parent c7bef78 commit a58c8cb

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

toc-source.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
"Name": "git request-pull",
5454
"category": "Collaboration",
5555
"short_description": "Generate a request to pull changes into a repository.",
56+
"long_description": "`git request-pull` generates a summary message describing the changes between two commits, which you can send to a project maintainer to request that they pull your changes. This is especially useful for email-based workflows or when collaborating outside of platforms like GitHub. The command outputs a message that includes a comparison summary, a list of commits, and their messages, making it easy for maintainers to review and apply your changes.",
5657
"command": "git request-pull <start> <url> <end>",
5758
"examples": [
5859
{
@@ -65,7 +66,9 @@
6566
}
6667
],
6768
"steps": [
68-
"Run `git request-pull <start> <url> <end>` to generate a pull request message."
69+
"Identify the base commit or branch you want to compare from (e.g., main or v1.0).",
70+
"Run `git request-pull <start> <url> <end>` to generate a pull request message.",
71+
"Send the generated message to the project maintainer (e.g., via email or chat)."
6972
],
7073
"links": [
7174
{
@@ -77,8 +80,9 @@
7780
"author": "mike-rambil",
7881
"last_updated": "2024-06-10",
7982
"protips": [
80-
"Use request-pull to generate a summary for code reviews.",
81-
"Include a clear start and end point for clarity."
83+
"Use this command when collaborating via email or outside of web-based platforms.",
84+
"Include a clear start and end point for clarity.",
85+
"Review the generated message before sending to ensure it accurately describes your changes."
8286
]
8387
}
8488
]

0 commit comments

Comments
 (0)