Home

Development Guidelines

Welcome to the mde wiki! The MDE SDK (Math Description Engine Software Development Kit) is an open-source library. It generates text, sound and graphical descriptions of mathematical graphs.

The Math Description Engine Software Development Kit can be used by software developers to make computer-rendered graphs more accessible to blind and visually-impaired users. It has a simple API that lets you easily add alternative text and sound descriptions to your graphs.

See the Programmer's Guide and API javadoc (in this repo) for detailed information. See the Development Guidelines if you will be contributing code or templates to the project.

Useful References:

Active MDE Development Project: https://github.com/benetech/mde

Original MDE Site: http://prime.jsc.nasa.gov/mde/

Mde Web Services: https://github.com/benetech/MDE-Web-Service

Communication

• IRC: #benetech-mde
• Google Group: https://groups.google.com/forum/?fromgroups#!forum/math-description-engine

Workflow Tracking

1. Since this is an open source project, let's story/task all our work and bugs on GitHub: https://github.com/benetech/mde/issues
2. I would recommend using labels to group issues related to a specific story and to identify bugs. I created a sample label: https://github.com/benetech/mde/issues?labels=NASA%2FGA+Tech+Code+Merge&page=1&state=open
3. As we finish each iteration, we can delete old story labels to keep the list manageable. For historical purposes, we should copy the label name into the issue description.
4. Once development has completed, the story can be marked as closed, but QA will label it as verified.
5. For burn down purposes we can use milestones per release. See: https://github.com/benetech/mde/issues/milestones?with_issues=no
6. Once we start working on the web service and UI, those issues will be tracked at: https://github.com/benetech/MDE-Web-Service/issues