Topaz FAQ

This contains administrative information for developers who wish to contribute to the Topaz Project.

FAQ

How do I get the source code?

You need a version of Subversion. Subversion is an open source tool, and is free to download.

The following command will get the latest version of Topaz:

svn co http://www.topazproject.org/svn/head

You can also browse the source code by pointing your browser directly at this link.

How do I contribute code?

Please mail contributions to the developers' list in patch format with comments and justification. One of the lead developers with add your code as soon as it can be tested.

How can I get read/write access to the source repository?

Ask an administrator on the developers' mailing list. Once you have established a good track record then we will consider giving you full read/write access to the repository. We hope to have a more formal process in place soon, so that the procedure will be open and accountable.

How do I learn the architecture of Topaz?

Eventually this information will be posted in the Topaz Wiki. In the meantime, try the following:

  • Download the source and read it. If code is not clear and comments are lacking, then please report it.
  • Ask on the developers' mailing list.

If you learn something that is not adequately documented, then please consider adding it to the Wiki.

What is this pubapp, plos, plosone, etc. I see liberally sprinkled everywhere?

Vestiges of an evolutionary software development process. It refers to the first application we built on top of Topaz for PLoS. This application has been renamed to Ambra and we are currently working on releasing this to the general public. Please bear with us as editorial mutations naturally select out non-functional marketing and technical terms.

Why is my question not answered here?

Because I didn't know about the issue and no one has asked me about it yet. Let one of the developers know, and we will put something up. Feel free to harass us if we take too long.