repos / git-pr

commit

343d806

parent

685977f

author

Eric Bower

date

2024-07-14 11:26:20 -0400 EDT

docs: readme

docs: add example flow using actual commands

 1@@ -86,7 +86,7 @@ web file server.
 2 ## format-patch workflow
 3 
 4 ```bash
 5-# Owner hosts repo `noice.git` using github
 6+# Owner hosts repo `test.git` using github
 7 
 8 # Contributor clones repo
 9 git clone git@github.com:picosh/test.git
10@@ -96,7 +96,7 @@ git clone git@github.com:picosh/test.git
11 git add -A && git commit -m "fix: some bugs"
12 
13 # Contributor runs:
14-git format-patch origin/main --stdout | ssh pr.pico.sh pr create noice
15+git format-patch origin/main --stdout | ssh pr.pico.sh pr create test
16 # > Patch Request has been created (ID: 1)
17 
18 # Owner can checkout patch:
19@@ -207,10 +207,14 @@ curl localhost:3000
20 > This project is being actively developed and we have not reached alpha status
21 > yet.
22 
23-1. Announce **Alpha status**
24-1. Remove reviews from `print` command
25-1. Git remote for repos
26-1. PR build steps (e.g. check that a patch can be cleanly applied)
27+1. Better `--cover-letter` support
28+1. Adapter to statically generate web view
29+1. Support a `diff` workflow (convert `git diff` into mbox patch format)
30+
31+## ideas
32+
33+1. Git remote for repos?
34+1. PR build steps? (e.g. check that a patch can be cleanly applied)
35 1. Review patch inline? (e.g. edit patch directly with comments `# xxx` then
36    reupload)
37 1. TUI?

 1@@ -172,6 +172,46 @@
 2         <li>Owner applies patches locally (<code>git-am</code>)</li>
 3         <li>Owner marks PR as accepted and pushes code to main (<code>git-push</code>)</li>
 4       </ol>
 5+
 6+      <div>Example commands</div>
 7+
 8+      <pre># Owner hosts repo `test.git` using github
 9+
10+# Contributor clones repo
11+git clone git@github.com:picosh/test.git
12+
13+# Contributor wants to make a change
14+# Contributor makes changes via commits
15+git add -A && git commit -m "fix: some bugs"
16+
17+# Contributor runs:
18+git format-patch origin/main --stdout | ssh pr.pico.sh pr create test
19+# > Patch Request has been created (ID: 1)
20+
21+# Owner can checkout patch:
22+ssh pr.pico.sh pr print 1 | git am -3
23+# Owner can comment (IN CODE), commit, then send another format-patch
24+# on top of the PR:
25+git format-patch origin/main --stdout | ssh pr.pico.sh pr add --review 1
26+# UI clearly marks patch as a review
27+
28+# Contributor can checkout reviews
29+ssh pr.pico.sh pr print 1 | git am -3
30+
31+# Owner can reject a pr:
32+ssh pr.pico.sh pr close 1
33+
34+# Owner can accept a pr:
35+ssh pr.pico.sh pr accept 1
36+
37+# Owner can prep PR for upstream:
38+git rebase -i origin/main
39+
40+# Then push to upstream
41+git push origin main
42+
43+# Done!
44+```</pre>
45   </details>
46 </header>
47