Development Overview

This page contains all the information you need in order to start working on the Sophie2 Project.

Getting Started

• The first thing to get started with is joining the mail groups and Skype group chats of Astea Solutions. See PLATFORM_INFRASTRUCTURE_OVERVIEW for details.

• The machine you are using for development should be provided with the software, described in PLATFORM_INFRASTRUCTURE_OVERVIEW.

• The hardware, software and platform requirements for running Sophie2 are listed in PLATFORM_NFR_COMPATIBILITY.

Technologies used

• Trac. This is our project management system that includes bug and issue tracking as well as an integrated wiki. The home page of the Trac project is ​http://trac.edgewall.org/. Information about using the Trac can be found under PLATFORM_INFRASTRUCTURE_OVERVIEW.

• Java Development Kit. Sophie2 is written in Java. That means you have to install Java Development Kit if you want to develop it. Java Runtime Environment (JRE) is required for running the project.

• Eclipse. Eclipse is the primary IDE tool used for developing Sophie2. More information about Eclipse and JDK can be found under PLATFORM_INFRASTRUCTURE_OVERVIEW

• Subversion (SVN) client. Subversion is the version control system that we use.

• Maven. Maven is a build manager used in the Sophie2 project.

Setup

• Subversion client. Download/Tutorial links: PLATFORM_INFRASTRUCTURE_OVERVIEW.
• Repository. Once you have installed SVN, read PLATFORM_INFRASTRUCTURE_OVERVIEW ("Checkout the project repository" paragraph) to setup the repository. The Sophie2 platform is located in trunk/sophie2-platform and its structure is described in PLATFORM_STRUCTURE.
• Eclipse
  • Download: PLATFORM_INFRASTRUCTURE_OVERVIEW.
  • Compiler Settings: COMPILER_SETTINGS.
  • Subclipse Installation: PLATFORM_INFRASTRUCTURE_OVERVIEW.
  • Maven integration: PLATFORM_INFRASTRUCTURE_OVERVIEW (the "Integration with Eclipse" paragraph).
  • Importing Running Sophie: PLATFORM_DEPLOYMENT_BUILD_ECLIPSE.
• Maven. For installing Maven, see PLATFORM_INFRASTRUCTURE_OVERVIEW.

Tasks

Process

TODO put a link to PROCESS

Performing tasks

• Writing analysis
• Task Tips
• Writing reports
• Coding
  • Code Tasks Requirements
  • Coding Conventions
  • Code Smells
  • Writing Javadoc
  • Logging
• Testing
  • Manual Tests
  • Auto Tests

Sophie2

Overview

TODO link to Sophie intro.

Aspects of Sophie

• Modularity
• Structure
• Properties
• MVC

Development issues

• Sophie Platform
  • Platform Design
  • Plugin Architecture
  • Core
  • Base
  • Features
• Sophie Server
• Sophie end product
• Project Community
• Supporting Artifacts

Getting Help

TODO

Useful Links

TODO

Comments

TODO