From 67521de4adc646c5bfe8de505b499197c79bd4de Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Tue, 20 Aug 2024 07:48:49 +0100 Subject: [PATCH] feat: add git-remote-nostr guide as a seperate quick start page update copy to reflect additional tool --- src/routes/+page.svelte | 207 ++++++++++++++++- src/routes/about/+page.svelte | 16 +- src/routes/ngit/+page.svelte | 6 - src/routes/quick-start/+page.svelte | 347 ++++++++++++++++++++++++++++ 4 files changed, 554 insertions(+), 22 deletions(-) create mode 100644 src/routes/quick-start/+page.svelte diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte index 4814400..5d66d71 100644 --- a/src/routes/+page.svelte +++ b/src/routes/+page.svelte @@ -83,8 +83,7 @@
- just for syncing data related to nostr's state eg. Gitea, Github, - Gitlab, self-hosted... + used only for syncing data eg. Gitea, Github, Gitlab, self-hosted...
@@ -132,10 +131,12 @@

- git remote nostr + git-remote-nostr

-
git plugin for seemless nostr integration
+
+ git remote helper (plugin) for seemless nostr integration +
@@ -146,8 +147,8 @@
- a command line tool to manage repos and advanced patch submission - and review + a command line tool to manage repos and advanced patch + submission / review
@@ -164,13 +165,195 @@ collaboration layer for code changes.

- ngit and gitworkshop.dev are tools to enable code collaboration over - nostr. ngit allows contributors to manage the flow to open a proposal, - maintainers to verify proposals and incorporate them into the project. - Gitworkshop.dev provides a visual interface to discuss proposals and open - issues. + Gitworkshop.dev, git-remote-nostr and ngit are tools to enable code + collaboration over nostr. Gitworkshop.dev provides a visual interface to + discuss proposals and open issues. git-remote-nostr enables proposal + creation, review and incorporation using standard git tooling. ngit + handles repository setup and advanced proposal submission. +

+
+ details +
+ + + +
+

Quick Start

+

+ Install ngit and + git-remote-nostr +

+

+ donwload binaries and add them to a directory from which they can be run + globally: +

+

+ Linux + Mac + Windows + v1.3.1

- learn more +

+ alternatively, if you have cargo installed runcargo install ngit +

+
+
+
+
+
+
+

for the contributor

+
+

+ clone the nostr url and use normal git operations with tool you are + used it (eg. your IDE) +

+
+
+ git clone nostr://npub123/repo-identifier +
+
+ // use pr/ branch prefix to create a nostr proposal +
+
+ git checkout -b pr/great-feature +
+
+ git commit -am "improve the + world" +
+
+ git push -u +
+
+ // any branch with pr/ prefix is nostr proposal +
+
+ git branch -r --list origin/pr/* +
+
+
+ full guide +
+
+
+
+
+
+

for the maintainer

+
+
+
+
+ // create a git repo and push to a git server +
+
+ git init +
+
+ git commit -am "initial commit" +
+
+ git remote add origin https://dm.co/usr/my-repo +
+
+ git push -u origin master +
+
+ // announce on nostr +
+
+
+ ngit init --identifier + my-repo +
+
+ git remote set-url + origin nostr://npub123/my-repo +
+
+ // pushing merged commits updates proposal status +
+
+ git merge origin/pr/great-feature(e8246b2) +
+
+ git push +
+
+
+
+
+ full guide +
+
+
+
+
+ + +

Example Repositories

These repositories have plenty of issues and proposals to explore

diff --git a/src/routes/about/+page.svelte b/src/routes/about/+page.svelte index 5bcc0da..216d9ba 100644 --- a/src/routes/about/+page.svelte +++ b/src/routes/about/+page.svelte @@ -20,8 +20,8 @@

About

- gitworkshop.dev and ngit are tools to enable code - collaboration over nostr created and maintained by + gitworkshop.dev, ngit and git-remote-nostr are tools + to enable code collaboration over nostr created and maintained by

- ngit and gitworkshop.dev implements optional features of nip34, which - enable: + git-remote-nostr, ngit and gitworkshop.dev implements optional features of + nip34, which enable: