Updated the README

This commit is contained in:
Leonard Smith 2020-10-13 17:35:23 -05:00
parent 25128eedc6
commit d3a7856c1a
5 changed files with 28 additions and 4 deletions

View File

@ -8,7 +8,7 @@ The following setups will create a complete copy of the source repository under
2. Click "Sign In" in the upper right corner
3. Enter your sign in credentials.
2. Navigate to the en_ulb_tagged repo: https://content.bibletranslationtools.org/WycliffeAssociates/en_ulb_tagged
3. Click on the fork button in just under the "Sign In" button on the upper right: ![Image of the repo header with fork button on the right of the page][doc_images/fork_button.png]
3. Click on the fork button in just under the "Sign In" button on the upper right: ![Image of the repo header with fork button on the right of the page](doc_images/fork_button.png)
4. On the "New Repository Fork" page, click the green "Fork Repository" button to create your new fork.
@ -17,10 +17,10 @@ After the following steps, you will have a complete copy of your forked repo on
1. Navigate to your newly cloned repository in Gitlab (if it is not already open).
2. Next to the blue "New File" and "Upload File" buttons select and copy the URL to clone the repo:
![Image of the clone URL location][doc_images/clone_url.png]
![Image of the clone URL location](doc_images/clone_url.png)
3. Open SmartGit.
4. Select Repository > Clone from the application menu.
5. Paste the clone URL into the Repository URL: ![Image of Remote Repository URL textbox][doc_images/repo_url.png]
5. Paste the clone URL into the Repository URL: ![Image of Remote Repository URL textbox](doc_images/repo_url.png)
6. Click "Continue."
7. On the following screen make sure "Include modules" and "Fetch all Heads and Tags" are both checked.
8. In the next screen enter or select the folder where you want to save your cloned repo and click "Finish."
@ -50,4 +50,28 @@ Then work on the translation issues and create another commit. That way, if we n
3. Highlight the file(s) you want to include in the new commit.
4. With the files highlighted, right click select "Commit" from the popup context menu.
5. In the opened commit dialog, select the files you want to include in this commit and add a commit message. Make sure your commit message indicates the changes you are saving.
6. Click "Commit".
6. Click "Commit". You should now see your new commit at the top of the tree in the Graph pane.
## Push your working branch to Gitlab
Now that you have a shiny new branch with some changes that are ready to be published to the main repository, you will need to push your new branch up to Gitlab.
1. In the branches pane locate and highlight your current working branch.
2. Right click on your branch name to bring up the popup context menu.
3. Click "Push To".
4. In the "Push 'my-new-branch-name' to a remote repository" dialog that opens make sure the "Target Repository" is set to "origin" and "Push To:" is set to "Tracked or matching branch".
5. Click "Push".
Your changes are now on your forked repository on the Gitlab server.
## Create a Pull Request
To move your changes into the main repository you must create a pull request. A pull request notifies the main repo administrators that you have new changes suggested and gives them an opportunity to review and approve your changes.
1. Sign-in to Gitlab: https://content.bibletranslationtools.org
2. On the landing page after you sign-in you will see a list of your activity on the left and a list of the repositories you have access to on the right. Look for <username>/en_ulb_tagged and click (<username> = the your Gitlab username).
3. Click the "Pull Requests" tab. ![Pull Request Tab](doc_images/pull_request_tab.png)
4. Click the green "New Pull Request" button. ![New pull request button](doc_images/new_pull_request_button.png)
5. In the newly opened form, give the PR a name and enter a description to summarize the changes you are suggesting. ![Pull Request Form](doc_images/new_pr_form.png)
6. Click "Save".
You have now created a new pull request.

BIN
doc_images/new_pr_form.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB