diff --git a/developer/new-developers/submitting-your-first-patch.md b/developer/new-developers/submitting-your-first-patch.md index f05cd3798dd9f366352a99b8f04affdb55f8388d..3cec65a118020e6269acc73808a58cb38a48185e 100644 --- a/developer/new-developers/submitting-your-first-patch.md +++ b/developer/new-developers/submitting-your-first-patch.md @@ -1,18 +1,15 @@ # Submitting your first patch -## Setting up Git and SSH - -(**To work smoothly with Gerrit.**) - -First see: - -* [Creating a gerrit review](working-with-gerrit) +```{seealso} +Set up Git and SSH to work smoothly with Gerrit. +First see [Creating a gerrit review](working-with-gerrit). +``` ### SSH setup <https://review.jami.net/Documentation/user-upload.html#ssh> -1. Generate a personal dedicated public/private key set. +1. Generate a personal, dedicated public/private key set. ```bash ssh-keygen -f ~/.ssh/jami_gerrit_review` ``` @@ -20,32 +17,32 @@ ssh-keygen -f ~/.ssh/jami_gerrit_review` Your identification has been saved in `jami_gerrit_review`. Your public key has been saved in `jami_gerrit_review.pub`. -2. Tell Gerrit your public key - 1. Login to [Gerrit](https://review.jami.net) via your GitLab account (Sign-in → OAuth GitLab) - 2. Follow the SSH key instructions found from (your) user options [settings](https://review.jami.net/settings/) - -3. Set up your local SSH (via `ssh-add` or in `~/.ssh/config`) -4. Test all of the above (SSH on the service or just try to clone a repo on Gerrit via SSH) +2. Tell Gerrit your public key. + 1. Log in to [Gerrit](https://review.jami.net) via your GitLab account (Sign-in → OAuth GitLab). + 2. Follow the SSH key instructions found in (your) user options [settings](https://review.jami.net/settings/). +3. Set up your local SSH (via `ssh-add` or in `~/.ssh/config`). +4. Test all of the above (SSH on the service or just try to clone a repo on Gerrit via SSH). -### Your Repository +### Your repository +```{important} This *assumes* you have moved any existing project clone out of the way. +``` -1. Clone a (fresh) copy of the project. `git clone ssh://USERNAME@review.jami.net:29420/PROJECT_NAME_GOES_HERE.git`; e.g. `git clone ssh://foo@review.jami.net:29420/jami-project.git`. -2. Configure this clones local .git/config (optional) -3. Generate commit Change-Ids -aka: commit-msg hook script +1. Clone a (fresh) copy of the project, `git clone ssh://USERNAME@review.jami.net:29420/PROJECT_NAME_GOES_HERE.git`; e.g., `git clone ssh://foo@review.jami.net:29420/jami-project.git`. +2. Configure this clone's local .git/config (optional). +3. Generate commit Change-Ids. + Also known as commit-msg hook script. -A shell script, to be installed to .git/hooks/commit-msg. +A shell script to be installed to .git/hooks/commit-msg. The script creates a unique Change_Id:hash for each commit made from your repository. -* The first time you attempt a _push_ to review `git push origin HEAD:refs/for/master`, - gerrit will notice a lack of Change-Id. +* The first time you attempt a _push_ to review `git push origin HEAD:refs/for/master`, Gerrit will notice a lack of Change-Id. * Gerrit will also present a secure copy (scp) string. Use *that* to download a copy of .git/hooks/commit-msg. ## References -+ [Some Gritty Details](https://review.jami.net/Documentation/user-upload.html#_gritty_details) \ No newline at end of file +* [Some Gritty Details](https://review.jami.net/Documentation/user-upload.html#_gritty_details) \ No newline at end of file