92 lines
4.6 KiB
Markdown
92 lines
4.6 KiB
Markdown
When contributing to another's project, it is common for the contribution to be
|
|
of many commits and involve a discussion with the project's maintainer. This is supported
|
|
via Radicle *patches*.
|
|
|
|
Here we give a brief overview for using patches in our hypothetical car
|
|
scenario. It turns out instructions containing the power requirements were
|
|
missing from the project.
|
|
|
|
```
|
|
$ git checkout -b flux-capacitor-power
|
|
$ touch REQUIREMENTS
|
|
```
|
|
|
|
Here the instructions are added to the project's `REQUIREMENTS` for 1.21
|
|
gigawatts and committed with git.
|
|
|
|
```
|
|
$ git add REQUIREMENTS
|
|
$ git commit -v -m "Define power requirements"
|
|
[flux-capacitor-power 3e674d1] Define power requirements
|
|
1 file changed, 0 insertions(+), 0 deletions(-)
|
|
create mode 100644 REQUIREMENTS
|
|
```
|
|
|
|
Once the code is ready, we open a patch with our changes.
|
|
|
|
``` (stderr)
|
|
$ git push rad -o no-sync -o patch.message="Define power requirements" -o patch.message="See details." HEAD:refs/patches
|
|
✓ Patch a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7 opened
|
|
To rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk
|
|
* [new reference] HEAD -> refs/patches
|
|
```
|
|
|
|
It will now be listed as one of the project's open patches.
|
|
|
|
```
|
|
$ rad patch
|
|
╭────────────────────────────────────────────────────────────────────────────────╮
|
|
│ ● ID Title Author Head + - Updated │
|
|
├────────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● a99d55e Define power requirements bob (you) 3e674d1 +0 -0 now │
|
|
╰────────────────────────────────────────────────────────────────────────────────╯
|
|
$ rad patch show a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7
|
|
╭────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7 │
|
|
│ Author bob (you) │
|
|
│ Head 3e674d1a1df90807e934f9ae5da2591dd6848a33 │
|
|
│ Branches flux-capacitor-power │
|
|
│ Commits ahead 1, behind 0 │
|
|
│ Status open │
|
|
│ │
|
|
│ See details. │
|
|
├────────────────────────────────────────────────────┤
|
|
│ 3e674d1 Define power requirements │
|
|
├────────────────────────────────────────────────────┤
|
|
│ ● opened by bob (you) (3e674d1) now │
|
|
╰────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
We can also confirm that the patch branch is in storage:
|
|
|
|
```
|
|
$ git ls-remote rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk refs/heads/patches/*
|
|
3e674d1a1df90807e934f9ae5da2591dd6848a33 refs/heads/patches/a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7
|
|
```
|
|
|
|
Wait, let's add a README too! Just for fun.
|
|
|
|
```
|
|
$ touch README.md
|
|
$ git add README.md
|
|
$ git commit --message "Add README, just for the fun"
|
|
[flux-capacitor-power 27857ec] Add README, just for the fun
|
|
1 file changed, 0 insertions(+), 0 deletions(-)
|
|
create mode 100644 README.md
|
|
```
|
|
``` (stderr) RAD_SOCKET=/dev/null
|
|
$ git push -o patch.message="Add README, just for the fun"
|
|
✓ Patch a99d55e updated to revision 25e7d77ed913ca07d06253988b73f392071d213d
|
|
To rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk
|
|
3e674d1..27857ec flux-capacitor-power -> patches/a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7
|
|
```
|
|
|
|
And let's leave a quick comment for our team:
|
|
|
|
```
|
|
$ rad patch comment a99d55e5958a8c52ff7efbc8ff000d9bbdac79c7 --message 'I cannot wait to get back to the 90s!' -q
|
|
8808e8b1d86dc51f5ed5c8b518df197e2c8f2fad
|
|
✓ Synced with 1 node(s)
|
|
```
|