feat: support pull requests
Support for pull requests, it's not standard in NIPs yet[1] but there must be two clients that support it to be included in NIPs, n34 is one of them. This support: - Create a new PR `n34 pr new` - Update PR tip `n34 pr update` - View a PR `n34 pr view` - List PRs `n34 pr list` - Add `PR` and `PR-update` kinds as roots in `NostrClient::find_root` - Support issuing statuses for PRs - Support GRASP PR and PR-update - Update the docs [1] https://github.com/nostr-protocol/nips/pull/1966
This commit is contained in:
30
docs/pr/new.md
Normal file
30
docs/pr/new.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Create a Pull Request
|
||||
|
||||
> `n34 pr new` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Usage: n34 pr new [OPTIONS] <--subject <SUBJECT>|--editor> <COMMIT> <CLONES>...
|
||||
|
||||
Arguments:
|
||||
<COMMIT> The SHA-1 hash of the commit at the tip of the PR branch
|
||||
<CLONES>... Repositories to clone for the pull request, separated by commas
|
||||
|
||||
Options:
|
||||
--repo <NADDR-NIP05-OR-SET> Repository addresses
|
||||
--body <BODY> The body content of the pull request. Cannot be used together with the `--editor` flag
|
||||
--subject <SUBJECT> The subject or title of the pull request. Cannot be used together with the `--editor` flag
|
||||
-e, --editor Opens the user's default editor to write PR subject and body
|
||||
--labels <LABELS> Labels to associate with the pull request, separated by commas
|
||||
--branch <BRANCH> The branch name for the pull request
|
||||
--grasp Push the pull request to the repository GRASP server
|
||||
```
|
||||
|
||||
Submit a pull request to the repositories specified using the `--repo` option or
|
||||
obtained from the `nostr-address` file.
|
||||
|
||||
Utilize the `--grasp` option if you intend to send the pull request to the
|
||||
[GRASP] servers. Note that `n34` will not automatically send the pull request
|
||||
for you but will indicate where to push your changes.
|
||||
|
||||
[GRASP]: https://ngit.dev/grasp
|
||||
Reference in New Issue
Block a user