rad-issue.md
1 Project 'todo' items are called 'issue's. They can be inspected and modified 2 using the 'issue' subcommand. 3 4 Let's say the new car you are designing with your peers has a problem with its flux capacitor. 5 6 ``` 7 $ rad issue open --title "flux capacitor underpowered" --description "Flux capacitor power requirements exceed current supply" --no-announce 8 ╭─────────────────────────────────────────────────────────╮ 9 │ Title flux capacitor underpowered │ 10 │ Issue 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d │ 11 │ Author z6MknSL…StBU8Vi (you) │ 12 │ Status open │ 13 │ │ 14 │ Flux capacitor power requirements exceed current supply │ 15 ╰─────────────────────────────────────────────────────────╯ 16 ``` 17 18 The issue is now listed under our project. 19 20 ``` 21 $ rad issue list 22 ╭───────────────────────────────────────────────────────────────────────────────────────────────────╮ 23 │ ● ID Title Author Labels Assignees Opened │ 24 ├───────────────────────────────────────────────────────────────────────────────────────────────────┤ 25 │ ● 9bf82c1 flux capacitor underpowered z6MknSL…StBU8Vi (you) now │ 26 ╰───────────────────────────────────────────────────────────────────────────────────────────────────╯ 27 ``` 28 29 Show the issue information issue. 30 31 ``` 32 $ rad issue show 9bf82c1 33 ╭─────────────────────────────────────────────────────────╮ 34 │ Title flux capacitor underpowered │ 35 │ Issue 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d │ 36 │ Author z6MknSL…StBU8Vi (you) │ 37 │ Status open │ 38 │ │ 39 │ Flux capacitor power requirements exceed current supply │ 40 ╰─────────────────────────────────────────────────────────╯ 41 ``` 42 43 44 Great! Now we've documented the issue for ourselves and others. 45 46 Just like with other project management systems, the issue can be assigned to 47 others to work on. This is to ensure work is not duplicated. 48 49 Let's assign ourselves to this one. 50 51 ``` 52 $ rad assign 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d --to did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi 53 ``` 54 55 It will now show in the list of issues assigned to us. 56 57 ``` 58 $ rad issue list --assigned 59 ╭─────────────────────────────────────────────────────────────────────────────────────────────────────────╮ 60 │ ● ID Title Author Labels Assignees Opened │ 61 ├─────────────────────────────────────────────────────────────────────────────────────────────────────────┤ 62 │ ● 9bf82c1 flux capacitor underpowered z6MknSL…StBU8Vi (you) z6MknSL…StBU8Vi now │ 63 ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────╯ 64 ``` 65 66 Note: this can always be undone with the `unassign` subcommand. 67 68 ``` 69 $ rad unassign 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d --from did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi 70 ``` 71 72 Great, now we have communicated to the world about our car's defect. 73 74 But wait! We've found an important detail about the car's power requirements. 75 It will help whoever works on a fix. 76 77 ``` 78 $ rad issue comment 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d --message 'The flux capacitor needs 1.21 Gigawatts' -q 79 1a8e9d3d62d22b247064b12d1d89ad8598504129 80 $ rad issue comment 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d --reply-to 1a8e9d3d62d22b247064b12d1d89ad8598504129 --message 'More power!' -q 81 fb6ab7e0ca5be3c34688bcae37d7302bb824decf 82 ``` 83 84 We can see our comments by showing the issue: 85 86 ``` 87 $ rad issue show 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d 88 ╭─────────────────────────────────────────────────────────╮ 89 │ Title flux capacitor underpowered │ 90 │ Issue 9bf82c141d5a9c54bb1d6b4517eb3bb7da8fb30d │ 91 │ Author z6MknSL…StBU8Vi (you) │ 92 │ Status open │ 93 │ │ 94 │ Flux capacitor power requirements exceed current supply │ 95 ├─────────────────────────────────────────────────────────┤ 96 │ z6MknSL…StBU8Vi (you) now 1a8e9d3 │ 97 │ The flux capacitor needs 1.21 Gigawatts │ 98 ├─────────────────────────────────────────────────────────┤ 99 │ z6MknSL…StBU8Vi (you) now fb6ab7e │ 100 │ More power! │ 101 ╰─────────────────────────────────────────────────────────╯ 102 ```