128 lines
3.5 KiB
Markdown
128 lines
3.5 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's 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 README for 1.21 gigawatts and
|
||
commit the changes to 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 (or create) a patch with our changes for the project.
|
||
|
||
```
|
||
$ rad patch open --message "define power requirements" --no-confirm
|
||
|
||
🌱 Creating patch for heartwood
|
||
|
||
✓ Pushing HEAD to storage...
|
||
✓ Analyzing remotes...
|
||
|
||
z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi/master (f2de534) <- z6MknSL…StBU8Vi/flux-capacitor-power (3e674d1)
|
||
1 commit(s) ahead, 0 commit(s) behind
|
||
|
||
3e674d1 Define power requirements
|
||
|
||
|
||
╭─ define power requirements ───────
|
||
|
||
No description provided.
|
||
|
||
╰───────────────────────────────────
|
||
|
||
|
||
✓ Patch fd1df2db86867aa859541464fa334d0b22988ea7 created 🌱
|
||
```
|
||
|
||
It will now be listed as one of the project's open patches.
|
||
|
||
```
|
||
$ rad patch
|
||
|
||
❲YOU PROPOSED❳
|
||
|
||
define power requirements fd1df2db868 R0 3e674d1 (flux-capacitor-power) ahead 1, behind 0
|
||
└─ * opened by did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi (you) [..]
|
||
└─ * patch id fd1df2db86867aa859541464fa334d0b22988ea7
|
||
|
||
❲OTHERS PROPOSED❳
|
||
|
||
Nothing to show.
|
||
|
||
$ rad patch show fd1df2db86867aa859541464fa334d0b22988ea7
|
||
|
||
patch fd1df2db86867aa859541464fa334d0b22988ea7
|
||
|
||
╭─ define power requirements ───────
|
||
|
||
No description provided.
|
||
|
||
╰───────────────────────────────────
|
||
|
||
commit 3e674d1a1df90807e934f9ae5da2591dd6848a33
|
||
Author: radicle <radicle@localhost>
|
||
Date: Thu Dec 15 17:28:04 2022 +0000
|
||
|
||
Define power requirements
|
||
|
||
diff --git a/REQUIREMENTS b/REQUIREMENTS
|
||
new file mode 100644
|
||
index 0000000..e69de29
|
||
|
||
```
|
||
|
||
Wait, lets 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
|
||
$ rad patch update --message "Add README, just for the fun" --no-confirm fd1df2db86867aa859541464fa334d0b22988ea7
|
||
|
||
🌱 Updating patch for heartwood
|
||
|
||
✓ Pushing HEAD to storage...
|
||
✓ Analyzing remotes...
|
||
|
||
fd1df2db868 R0 (3e674d1) -> R1 (27857ec)
|
||
1 commit(s) ahead, 0 commit(s) behind
|
||
|
||
|
||
✓ Patch fd1df2db86867aa859541464fa334d0b22988ea7 updated 🌱
|
||
|
||
```
|
||
|
||
And lets leave a quick comment for our team:
|
||
|
||
```
|
||
$ rad comment fd1df2db86867aa859541464fa334d0b22988ea7 --message 'I cannot wait to get back to the 90s!'
|
||
84ef44764de73695cf30e6b284585d2c50d6d0e5
|
||
$ rad comment fd1df2db86867aa859541464fa334d0b22988ea7 --message 'I cannot wait to get back to the 90s!' --reply-to 84ef44764de73695cf30e6b284585d2c50d6d0e5
|
||
2fa3ac18d82ebdafe73484a15fa9823355c4664b
|
||
```
|
||
|
||
Now, let's checkout the patch that we just created:
|
||
|
||
```
|
||
$ rad patch checkout fd1df2db86867aa859541464fa334d0b22988ea7
|
||
✓ Performing patch checkout...
|
||
✓ Switched to branch patch/fd1df2db868
|
||
```
|