Merge pull request #48 from mike-rambil/devBranch

feat: add example for `git request-pull` in toc-source.json to enhanc…
This commit is contained in:
Micheal Palliparambil
2025-07-10 22:20:58 -05:00
committed by GitHub
2 changed files with 28 additions and 0 deletions

View File

@@ -17,6 +17,30 @@ git request-pull <start> <url> <end>
```
#### Examples
- **Generates a summary like:
The following changes since commit 1234567... (main):
Some previous commit message
are available in the Git repository at:
https://github.com/example/repo.git feature-branch
for you to fetch changes up to 89abcde... (feature-branch):
New feature commit message
Another commit message
----------------------------------------------------------------
file1.txt | 10 ++++++++++
file2.js | 5 +++++
2 files changed, 15 insertions(+)**
```sh
git request-pull main https://github.com/example/repo.git feature-branch
```
- **Generate a pull request message from v1.0 to v1.1.**

View File

@@ -56,6 +56,10 @@
"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": [
{
"code": "git request-pull main https://github.com/example/repo.git feature-branch",
"description": "Generates a summary like:\n\nThe following changes since commit 1234567... (main):\n\n Some previous commit message\n\nare available in the Git repository at:\n\n https://github.com/example/repo.git feature-branch\n\nfor you to fetch changes up to 89abcde... (feature-branch):\n\n New feature commit message\n Another commit message\n\n----------------------------------------------------------------\n file1.txt | 10 ++++++++++\n file2.js | 5 +++++\n 2 files changed, 15 insertions(+)"
},
{
"code": "git request-pull v1.0 https://github.com/example/repo.git v1.1",
"description": "Generate a pull request message from v1.0 to v1.1."