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.
• 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.

Supplementary documents

• Coding standards for: Java, CSS, HTML

• Best practices for:

  • UI design
  • Coding
  • Testing
  • Data migration

• How to set up IDEs for development. (not actively supported/maintained; use at your own risk)

How-to documents

• Static analysis: Performing code quality check.
• Setting up third-party email providers.
• Setting up CAPTCHA.
• Snapshot testing
• E2E testing