README.md

Documentation For Developers

Here are some documents important for TEAMMATES developers.

Main documents

• The project vision, challenges, and principles from a developer's perspective.
• The glossary of terms used in the project.
• Software Design - Architecture, APIs, etc.
• How to set up the developer environment.
  • How to set up some IDEs for development.
• Development guideline - how to work with your own copy of TEAMMATES.
• The workflow/process to follow when contributing to TEAMMATES.
• Developer Troubleshooting Guide
• How the issue tracker is used - issue lifecycle, issue labels, etc.
• Maintainer Guide - for core team members.

Supplementary documents

• The developer community structure.

• Coding standards for: Java, JSP, JavaScript, CSS, HTML

• IntelliJ Automated Setup Behavior

• Archived Documentation: documentations written in the past and are no longer maintained.

How-to documents

• Compressing images: How to compress images for use in TEAMMATES.
• Managing dependencies
• Static analysis: Performing code quality check.
• Setting up third-party email providers.
• "GodMode"

Technical Reports

These are the in-depth descriptions about various aspects of the project.

• Measuring the scalability and performance of TEAMMATES - by Samson Tan Min Rong