Using Git for Your Editor Trees Assignment
For the Editor Trees assignment, you will be doing team development. We want you to use a source control system called git. For this project you will be managing a repo and also using it to submit your assignment.
Step 1: Forking The Starter Repo
This step should only be done by one member of your Editor Trees team.
- Go to this URL: https://ada.csse.rose-hulman.edu/CSSE230/TermProject/editortrees
You'll have to login with your rose credentials.
- Click "fork" and select your name as the namespace
- On the left hand side navigation pane:
Click Settings | General
Then in the main window click the Expand button next to Permissions
After expanding Permissions, choose "Private" from the Project Visibility dropdown box
Scroll down and click "Save Changes"
- Navigate to: Settings | Members
Then in the main window invite your other team member
as a "Maintainer" by typing their Rose-Hulman userID into the "Select members to invite" search box.
Note: If GitLab does not recognize their userID, then they will need to
point their browser to https://ada.csse.rose-hulman.edu/hollings and click "Sign In" and then login with their Rose credentials - this will make them show up in the search box
- Invite the CSSE 230 TA's, graders, and me to be Maintainers of your project so that we will have access to grade and/or give help:
Invite: Joseph Hollingsworth, Anne Boxeth, Blake Mullalley, Abizer Naseem, Xinyu Shen
- Find your repo URL looking beneath your project's name on the main project page and clicking the dropdown box that contains "SSH" and changing it to "HTTPS".
The URL will look like the following with the "XXXXXX" replaced with your Rose userID:
https://ada.csse.rose-hulman.edu/XXXXXX/editortrees.git
Click on the icon just to the right of your URL, this will copy the URL to your clipboard. On the next step you will paste it into a spreadsheet.
- Click on the following link that takes you to a Google sheet and enter in your URL next to your team name:
Go to this spreadsheet and set the URL for your team
Google Sheet for recording repo URL
Step 2: Checking out the Repo
This step should be done by everyone on your team.
- In your browser, go to https://ada.csse.rose-hulman.edu and verify that you have access to your project. Copy the Repo URL (the HTTPS version, not the SSH version).
- Open your Eclipse and go to File > Import > Git > Projects from Git
- Select "Clone URI"
- In the URI field paste the URL you took from the website. Host and repository path should get filled out for you
- In Authentication, enter your rose credentials (you might find it convenient to have it save these for you) and hit Next
- In branch selection make sure "master" is checked and click next
- In local destination, you can configure anywhere you like
- Select "Import existing eclipse projects" and select next.
- You should see "EditorTrees" on the list, make sure it's checked and select next
- You should see a folder for EditorTrees in your project browser
Step 3: Test Push and Pull
Have one member of your team make a change and push it. Here's how:
- In Eclipse, edit the EditTree.java file (add at the top of the file a JavaDoc comment, i.e., /** ... */ and put @author tag with your team name) and save it
- Right click on the project folder and select Team > Commit
- Verify that EditTree.java appears in your list of "Staged Changes"
- Add "added author" to the Commit Message
- Select Commit and push
Have the other members of your team pull the latest version (after doing Step 2 above)
- Right click on the project folder and select Team > Pull
- You might have to enter your credentials
- You should get the updated files
Step 4: Let's do this
You have the basics!
- Now its time to start working on the Editor Trees assignment
Done!
Good Advice for Minimal Merge Conflicts
- Pair program whenever possible
- Always do a Team Pull before you begin programming
- Always to a Team Commit/Push when you finish
- If you do have to resolve a merge conflict, remember you must accommodate both changes