CSE 464: Group Project

Getting started

1. Download GitHub Desktop
2. Clone this repo using the current URL in your web browser
3. Open up the miami-university-cse-464-group-project folder with an IDE or text editor of your choice
4. Install the EditorConfig plugin for your IDE/text editor

Git workflow

1. Decide on a feature you want to work on
2. Pull changes from GitHub
3. Create a new branch for that feature (ex: add-some-feature-name)
4. Work in your IDE/text editor
5. Add and commit your changes once you are done. Give a brief summary of what your changes are. Write in the imperative mood (ex: "Fix typo" instead of "Fixed typo")
6. Once your changes are good enough to share, push them to GitHub
7. If the feature is complete and bug-free, make a pull request on GitHub to merge your branch into the master branch
8. Then it can be reviewed by another group member and merged into master

You can also work on multiple features at once. For this, you will need to maintain two branches and keep work for each feature separate.

While you are working, if you would like to switch to another branch but you are not ready to make a commit, you may want to look into git stash. It effectively makes a temporary commit that you can resume later by running git stash pop. If you have multiple stashes, you may want to reference them by name (see git stash list). This feature can only be used from the commandline.

License

Code

MIT (see LICENSE)

Non-code (documentation, etc.)

This work by John Meyer, Scott Harris, Jacob Freedman, & Bryan Hayes is licensed under a Creative Commons Attribution 4.0 International License.