This repository is a copy from the ECSE 223 Model Based Programming Group Project. The original project repository was set to private access.
Guide
You may ignore steps 1 and 2 since we do not really have tasks and issues yet
- Go to the "Issues" tab on GitHub.
- Look for an issue to fix or create your own issue (press "New issue").
- If you are fixing another person's issue:
- You can leave a comment if you have questions for the guy (or girl) who created the issue.
- Go directly to step 3.
- If you are creating your own issue:
- You must add the label/milestone sprint1, sprint2, or sprint3. Otherwise, the TA won't be able to check our issues.
- Also, add a priority label if necessary:
- If it needs to be fixed in the next 24 hours and it's really important, use the "Priority 1 [Urgent!]" label.
- If it's really important but we have time, use the "Priority 2" label.
- If it's somewhat important, use the "Priority 3" label.
- You can add other labels like "bug", "help wanted", or "question" to make your issue more helpful to others.
- If you are fixing another person's issue:
- Create branch:
git branch <branch-name>
- Go to branch:
git checkout <branch-name>
- Fix the issue (this is the step where you actually make changes to the code!).
- Commit your code:
- Add to commit:
git add <filename>
--> PLEASE DO NOT USEgit add .
orgit add *
git status
and check that the proper files are green- To undo step 1:
git reset
- Commit:
git commit -m "Commit Message"
- In the
"Commit Message"
, you can automatically close an issue by including the phrasecloses #4
(in this case#4
is the ID number of the issue, you can find this number in the "Issues" tab on GitHub). - Aside from
closes
, you can use the keywords:close
,closed
,fix
,fixes
,fixed
,resolve
,resolves
, orresolved
. It can be capitalized too.
- In the
- Add to commit:
- Push your code to online master branch:
git push -u origin <your-branch-name>
(DO NOT push from your local master branch). - Go to the "Pull requests" tab on GitHub. Press the "Create pull request" button for your branch.
- Approve your pull request in "Pull requests" tab.
- 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.
- Switch to master branch:
git checkout master
- Pull from master branch:
git pull origin master