• Group B, Team 5
• Alex Robertson (roberta1tcd)
• Finn Wright (CloudyUnity)
• Kyara (Cosmo) McWilliam (Kya-ra)
• Mateusz Orlowski (MO1805)
• Matthew Poole (MPoole1105)
• Thomas Creagh (ThomasCreagh)

Feel free to disagree with any of these. We can put it up to a vote.

• All member variables look like "m_varName".
• Constant (final) variables use CONSTANT_SNAKE_CASE.
• Non-constant but static/gloabl variables use "s_StaticCase".
• Any classes that are acting as structs should have their identifier appended with "Type".
• All classes should have their identifier appended with "Class".
• All interfaces and interface methods should start with "I".
• There should be no global variables if possible (Excluding the class instances created in Main).
• Keep stuff private whenever possible. The codebase should generally only talk in one direction.
• Avoid using this.memberVar when possible
• Keep all member variables at the top of the class/struct above functions
• Store colours as ints, then when needed call fill(color(m_colour)) as it seems to be unreliable if the fill call will work otherwise.

• There should be as few comments as possible. Use self-documenting code techniques. Use your best judgement.
• The spec requires comments. Use comments.
• Avoid nesting statements multiple times. Use guard clauses and methods to break stuff up.
• Each method should do only a single task and the name should accurately describe what it does. Don't be afraid of long identifier names.
• The Main tab should have minimal functions like setup() and draw() and getting input.
• One-line if statements don't need body brackets but the body goes on the next line
• Multi-line if statements need body brackets and the body goes on the next line

• Use sameline curly brackets.
• Keep stuff indented properly! Use Ctrl-T to do it automatically.
• "var" is BANNED except for during foreach loops.

• Create Widgets then add them to your screen using the addWidget method.
• Create methods then link them to your widgets with the widget.getEvent().addHandler(e -> eventHandler(e)); pattern.
• If you're creating a new widget with child widgets, they must be added to the m_children ArrayList.
  • Events will be called on child widgets.
  • Parent widgets are responsible for calling the draw method on child widgets. This is so that the parent can control the order they get drawn in and if they get drawn at all. This may change in the future.

Note that you might be able to do this using a git extension for processing, cmd or otherwise but I'll explain how I do it.

1. Open up Git Bash
2. Change to the directory. For me it's:
   cd "C:\Users\finnw\OneDrive\Documents\Trinity\CS\Project\FATMKM"
3. Add all your changes to the current working commit
   git add .
4. Make a commit
   git commit -m "Commit message describing what was changed"
5. Push your changes to the remote branch
   git push origin master
6. If you get no error messages, congrats you have pushed your changes successfully! Go check the github to make sure it worked. If you get an error message like this then continue following these instructions:
   ! [rejected] master -> master (fetch first)
   error: failed to push some refs to 'https://github.com/CloudyUnity/ProcessingFATMKM.git'

7. Pull the master branch changes into your local repo
   git pull --rebase origin master
8. You might be asked to resolve some conflicts. If you can get git working with some text editors it can make your life easier.
9. Conflict with missing file. For example if a file was removed in the master branch but you were making changes to it. Move all your changes outside of the file and then delete it
   git rm fileNameExample.txt
10. Other conflicts. I don't have experience here but try your best. Don't accidentaly delete everything without a backup. Try doing this to add new files to the commit:
    git add .
11. Now that you have resolved all conflicts you can continue
    git rebase --continue
12. You'll be asked to make a commit message again. If you're not familiar with vim text editors this may help:
    "i" enters insert mode where you can add text to your message
    "Esc" exits insert mode to allow you to use the following commands
    ":w" writes and saves the changes
    ":q" quits the editor. Make sure to do ":w" first
    You should see this message:
    Successfully rebased and updated refs/heads/master.
13. Now that your local repo is synced up it's time to push your changes again git push origin master
14. Once committed to master, delete your branch or local repo to prevent it getting behind.

• Cannot get working directory:
  • Use sketchPath()
• Fill not working with a variable of type color:
  • Store the colour as an int then call fill as fill(color(variable));
• Getting the error "The nested type ApplicationClass cannot hide an enclosing type.":
  • Delete "sketch.properties" file.
  • Ensure project directory is named "High5ive".

• Preprocess data into binary (Kyara (Cosmo) McWilliam (Cajm0))
• Read data very efficiently (Thomas Creagh (Thomas Creagh))
• Query data (Thomas Creagh (Thomas Creagh) & Kyara (Cosmo) McWilliam (Cajm0))
• Manipulate data (Thomas Creagh (Thomas Creagh) & Kyara (Cosmo) McWilliam (Cajm0))
• Conjoin data with other dataset (Thomas Creagh (Thomas Creagh) & Kyara (Cosmo) McWilliam (Cajm0))
• Create GUI widgets (Alex Robertson (roberta1tcd))
• 3D flight map (Finn Wright (CloudyUnity))
• 2D flight map (Mateusz Orlowski (MO1805))
• Design the gui place widgets (Matthew Poole (MPoole1105))