A class group project aimed at developing a proper Android application.
Please do not push your changes directly to the main branch.
All changes should be made on their respective branch and merged via a pull-request.
To get the project on your machine, you must first clone it by running the following:
git clone https://github.com/Letharrick/comp-3350-project.git
While all of the code will reside in the main branch, when working on a particular feature for the project, you must create and work on a branch for that feature.
To create and switch to a new local branch, run the following:
git checkout <BRANCH_NAME> -b
This will create a new local branch called BRANCH_NAME and switch over to it from the main branch
Now that you are on a new branch for your feature, you can now start making some changes to the project.
Make as many changes as you'd like by editing, adding, or removing files.
Once you are finished making your changes, you must then stage the changes to prepare for making a commit to your branch.
To stage the changes for a specific file, run the following:
git add <FILE_PATH>
Alternatively, you can stage all of your changes at once by heading to the root of the project directory and running:
git add .
Once your changes have been staged, you can then create a commit with a message describing your changes by running:
git commit -m "<MESSAGE>"
The commit message is not very important, but try to add at least a sentence describing the gist of the changes that are being committed.
Also, feel free to create multiple commits on your branch to break up the work if it is you are working on a feature that consists of a lot of changes.
Once your changes have been committed, you can then push your commits up to the repository.
If it is your first time pushing on your local branch, then you must run the following:
git push -u origin <BRANCH_NAME>
If it is not your first push on that branch, then the following will suffice:
git push
Don't worry if you forget this detail, as git will actually remind you about this and give you a message with the correct command to use in the case that you chose the wrong one.
For the final step, you will need to create a pull-request which describes the feature that was implemented on the branch and requests for your branch to be pulled into the main branch.
To do this, visit the GitHub repository and you will see a yellow-ish banner stating that you have changes on a branch, and on that banner will be a green button that says Compare & Pull Request, click this to create your pull-request.
For your pull-request, please provide an informative title and description which provides details regarding the changes you've made.
Once finished, open the pull-request and notify the group in Discord.
Once your changes have been discussed and approved by the group, your pull-request will then be merged into main!