feat: enhance long description and steps for git request-pull in toc-source.json to improve clarity and usability

This commit is contained in:
mikerambil
2025-07-10 21:59:39 -05:00
parent c7bef78708
commit a58c8cbdfd
+7 -3
View File
@@ -53,6 +53,7 @@
"Name": "git request-pull",
"category": "Collaboration",
"short_description": "Generate a request to pull changes into a repository.",
"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.",
"command": "git request-pull <start> <url> <end>",
"examples": [
{
@@ -65,7 +66,9 @@
}
],
"steps": [
"Run `git request-pull <start> <url> <end>` to generate a pull request message."
"Identify the base commit or branch you want to compare from (e.g., main or v1.0).",
"Run `git request-pull <start> <url> <end>` to generate a pull request message.",
"Send the generated message to the project maintainer (e.g., via email or chat)."
],
"links": [
{
@@ -77,8 +80,9 @@
"author": "mike-rambil",
"last_updated": "2024-06-10",
"protips": [
"Use request-pull to generate a summary for code reviews.",
"Include a clear start and end point for clarity."
"Use this command when collaborating via email or outside of web-based platforms.",
"Include a clear start and end point for clarity.",
"Review the generated message before sending to ensure it accurately describes your changes."
]
}
]