Update Contributing to Gryphon authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
...@@ -22,7 +22,7 @@ Please set up GitLab with your SSH RSA key and please set up a working directory ...@@ -22,7 +22,7 @@ Please set up GitLab with your SSH RSA key and please set up a working directory
git clone git@gitlab.nps.edu:monterey-phoenix/user-interfaces/gryphon.git git clone git@gitlab.nps.edu:monterey-phoenix/user-interfaces/gryphon.git
## Creating your branch ## Create your branch
When you clone a repository it places you on the "master" branch. Create a branch to work on. Once you have made changes and added code, those changes can be merged via a pull request. When you clone a repository it places you on the "master" branch. Create a branch to work on. Once you have made changes and added code, those changes can be merged via a pull request.
Create a branch name for your work. For example to start work on new branch "my fix" type: Create a branch name for your work. For example to start work on new branch "my fix" type:
...@@ -50,6 +50,14 @@ This commits your change to your clone of the repository, but it does not push y ...@@ -50,6 +50,14 @@ This commits your change to your clone of the repository, but it does not push y
git push -u origin "my fix" git push -u origin "my fix"
## Submit a pull request ## Submit a pull request
Once your branch is uploaded, create a pull request on GitLab (GitLab calls this a merge request): Once your branch is uploaded, create a pull request on GitLab (GitLab calls this a merge request). For detail please see https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html.
* From your browser, open the NPS GitLab repository at https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/tree/master * From your browser, open the NPS GitLab repository at https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/tree/master
* Verify that your branch is there: near the upper-left, click the drop-down, likely indicating "master", to reveal the branches and tags. You should see your "my fix" branch.
* At the left, click on "Merge requests". A new merge request page opens. Select your source branch. The target branch is "master". Click "Compare branches and continue". A "New merge request" page opens.
* Fill in the form. For Description, please include details to help us understand any specific details about the request. Please also provide steps for testing to help with validating expected behavior. Then click "Create merge request".
* At this point, the request is submitted and it shows up in the merge list under "Merge requests".
## Merging pull requests into master
* An assigned developer reviews your pull request and may ask questions or request changes.
* Once reviewed, the assigned developer may approve the pull request.