Quick Start
pre-requesite: install ngit
Installation Command:
Contributor Quick Start
pre-requesite: install ngit and git-remote-nostr
1. find repository
- search gitworkshop.dev/search for the repository
- explore PRs and issues
- copy the git clone url (or press the green clone button to copy the clone command)
2. clone repository
- using your prefered git client or with the git command you just copied:
git clone nostr://npub123/repo-identifier
3. submit PR
- push a branch with the prefix `pr/` for example using git commands:
git checkout -b pr/great-featuregit commit -am "improve the world"git push -u - OR for more options such as including a cover letter use ngit:
ngit send
4. view PRs
- for open PRs view remote branches with prefix `pr/` for example using git command:
git branch -r --list origin/pr/* - OR using ngit:
ngit list
5. update PR
- if you are the PR author, or a maintainer you can add commits to a PR:
git commit -am "extra thing"git push - or revising it:
git commit -a -amendgit push --force
Maintainer Quick Start
pre-requesite: install ngit and git-remote-nostr
1. create a local git repo
- for example using git commands:
git initgit commit -am "initial commit"// create repository on git server and the:
2. initialize on nostr
- initialize:
ngit init
3. view PRs
- for open PRs view remote branches with prefix `pr/` for example using git command:
git branch -r --list origin/pr/* - OR using ngit with more options such as applying them directly:
ngit list
4. merge / incorporate PRs
- the PR status will be automatically updated if you merge the branch:
git checkout mastergit merge pr/great-feature(e8246b2)git push - use gitworkshop.dev to make comments or manually set the status.
ngit list
5. consider turning off PRs and issues elsewhere
- If you are pushing your project to github, codeberg, bitbucket, etc., consider turing off PRs and issues so they can be managed solely on nostr.
- Note: for github use
Repo Settings > Featuresfor issues but turning off PRs isn't yet possible.