-
Notifications
You must be signed in to change notification settings - Fork 1
Development
Note: This document is taken from development practices for Synoptic (another cool project developed at UW) and modified according to Quick Fix Scout project's needs. For the original document see: https://github.com/ModelInference/synoptic/wiki/DocsDevelopmentPractices
Quick Fix Scout is and Eclipse plug-in written in Java and is developed using Eclipse.
For a description of Quick Fix Scout, see http://www.kivancmuslu.com/Quick_Fix_Scout/Home.html.
For a detail description of our development practices, see DevelopmentPractices.
TODO: Fill details
We prefer to maintain code documentation as close to the code as possible. This means that you should strive to maintain code documentation in the code, not on the wiki.
We have found the following plugins to be useful during development, so we recommend that you install and use them.
- MercurialEclipse : integrates hg with Eclipse
- EclEmma : provides code coverage feedback
- FindBugs : finds common bugs
- JDepend : tracks class dependencies in a project
- CheckStyle : checks code style and alerts you of problems
- Emacs+ : in-depth integration of emacs with Eclipse
We also use Crystal, a tool for proactive detection of conflict in hg. Follow the user manual to set up Crystal.