Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.77 KB

Contributing.md

File metadata and controls

55 lines (31 loc) · 1.77 KB

Development

If you are looking to get involved improving this project, this guide can help you get started quickly.

Structure

Major folders in the project and their purpose:

main/java/

  • core/

    Includes classes (and groups of classes - packages) that are fundamental to building, and running the project.

  • proto/

    Meant to mean "prototype". Classes in this package extends components of the standard JDK (mainly javax.swing) purposely to initialize them with project-specific values.

  • utg/

    Includes the main class, and its extensions. These set of classes determines how Dashboard should load.

main/resources/

  • icons/

    All image icons used by the project are placed in this folder for uniform access.

  • META-INF/

    Contains the MANIFEST file used by Maven in generating the Jar artefact.

test/

Maven test folder.

Skills

  • Core Java: Object-Oriented Programming
  • Serialization
  • Maven
  • HTML

Knowledge about UTG, its programs, and courses is important.

Furthermore

Please make sure to read the Logic statement, the Convention as well as the Glossary.

Serialization

Dashboard uses serialization/deserialization to save/retrieve user's data as s/he uses the program. The serialization approach ("what" & "how") is very tentative, and forms a key part in making releases backward-compatibile. Thus, developer must take great care regarding this component of the project. More information about serialization per-implementation is discussed in the serialDir.txt and serialInfo.txt files.