Ecse211

This is where all code will be uploaded

How to Use this GitHub Repository

How to Clone

To clone this repository, enter git clone https://github.com/Ecse211 in the desired directory. It will create a Ecse211 folder containing our project code.

How to Make Changes to Our Project

Quick Guide

1. Before making changes or switching branches, make sure to pull.
2. Do not make changes in the master branch.
   1. Instead, make a new branch: git branch <branch-name>
   2. This new branch is basically a copy of the master branch.
   3. Go to new branch: git checkout <branch-name>
   4. List all branches: git branch
3. Only pull from the master branch.
   1. Go to master branch: git checkout master
   2. Pull from master branch: git pull origin master
4. To commit changes: git commit -m "Commit Message"
   1. If you want ot close issue 3 for example, your commit message should include Closes #3.
5. To push changes to GitHub: git push -u origin <branch-name>
6. To merge pushed changes with master branch, create a pull request and get one person to approve your request.

Long Guide

1. Go to the "Issues" tab on GitHub.
2. Look for an issue to fix or create your own issue (press "New issue").
   1. If you are fixing another person's issue:
      1. You can leave a comment if you have questions for the guy (or girl) who created the issue.
      2. Go directly to step 3.
   2. If you are creating your own issue:
      1. You must add the label/milestone sprint1, sprint2, or sprint3. Otherwise, the TA won't be able to check our issues.
      2. Also, add a priority label if necessary:
         1. If it needs to be fixed in the next 24 hours and it's really important, use the "Priority 1 [Urgent!]" label.
         2. If it's really important but we have time, use the "Priority 2" label.
         3. If it's somewhat important, use the "Priority 3" label.
      3. You can add other labels like "bug", "help wanted", or "question" to make your issue more helpful to others.
      4. If you want to include a comment for your issue, it can be in the form of a user story: As a <type of user>, I would like <feature description> so that <rationale>.
      5. Example user story: As a course instructor, I would like to add content to a course so that enrolled students can access it on demand.
3. Create branch: git branch <branch-name>
4. Go to branch: git checkout <branch-name>
5. Fix the issue (this is the step where you actually make changes to the code in our project!).
6. Commit your code:
   1. Add to commit: git add <filename>
   2. Ensure that the proper files are green in git status
   3. To undo step 1: git reset
   4. Commit: git commit -m "Commit Message"
      1. In the "Commit Message", you can automatically close an issue by including the phrase closes #4 (in this case #4 is the ID number of the issue, you can find this number in the "Issues" tab on GitHub).
      2. Aside from closes, you can use the keywords: close, closed, fix, fixes, fixed, resolve, resolves, or resolved. It can be capitalized too.
7. Push your code to online master branch: git push -u origin <your-branch-name> (DO NOT push from your local master branch).
8. Go to the "Pull requests" tab on GitHub. Press the "Create pull request" button for your branch.
9. Travis CI will tell you if your build succeeded or failed in the Pull requests tab.
10. If it failed, go back to step 5.
11. If it succeeded, get someone to approve it in "Pull requests" tab.
12. If you didn't automatically close the issue you were trying to fix in step 6.1.1, you can do that manually right now. Go to the "Issues" tab, click the issue you fixed, then press the "Close issue" button.
13. Switch to master branch: git checkout master
14. Pull from master branch: git pull origin master