...
GitHub | All of our code repositories are available at this URL. To submit code to Islandora, send a pull request. Our release manager tests and merges code into the main Islandora repository. | |
Developers Meetings | Skype | Our developers meet weekly to review open tickets and review the status of the code. If you are interested in attending a developer meeting, please submit a request to islandora@upeito community@islandora.ca or or on the developers Google Group mailing list. |
JIRA | Our JIRA is the place to submit bugs and feature requests relating to Islandora. It is easy to make an account so you can submit tickets. | |
Wiki | This documentation is maintained on a wiki. If you have an account, you can edit the wiki. | |
Islandora.ca | At Islandora.ca, you will find our most current news, as well as information about Islandora events , and links to our community spaces. | |
Google Groups | A place for developers to answer questions and keep tabs on code development | |
Google Groups (Users) | A place for users and implementers to ask questions and get support | |
| http://www.facebook.com/Islandora | A facebook page where we post updates and events | |
| http://twitter.com/Islandora | Our Twitter feed. The first place for news and updates about the Islandora community. |
...
Anyone developing for the Islandora module is to follow the Drupal coding standards (http://drupal.org/coding-standards). This will be tested at commit time by the coder module Coder Module (http://drupal.org/project/coder). In order to make things easier, try to test your code with the coder module before committing code to the islandora GIT. There are also some great pages on the Drupal Wiki (http://drupal.org/node/147789) about how to setup your favorite Integrated Development Environment (IDE) to use the Drupal standards.
Here are some examples:
This page covers the standards for documentation in Islandora code. Most of this page is taken directly from the Drupal Doxygen and Comment Formatting Standards (http://drupal.org/node/1354). There have been some modifications specifically for Islandora; when in doubt, refer to the Drupal standards.
There are two types of comments: in-line and headers. In-line comments are comments that are within functions. In Islandora, documentation headers on functions, classes, constants, etc. are specially-formatted comments used to build the API and developer documentation. The system for extracting documentation from the header comments uses the Doxygen generation system, and since the documentation is extracted directly from the sources, it is much easier to keep the documentation consistent with the source code.
There is an excellent Doxygen manual at the Doxygen site http://www.stack.nl/~dimitri/doxygen/manual.html. This page describes the Islandora implementation of Doxygen, and our standards for both in-line and header comments.
...
Whenever we interact with Fedora in the comments using either:
we We need to document what is returned on error and what state the Fedora is left in, so that the error can be reported through Drupal instead of failing silently and whoever is calling the API can make a choice about what to do next.
...
In order to generate the documentation you need the doxygen package installed.
Download this file the Doxyfile to your modules/fedora_repository folder and run the command:
...
Then doxygen will only extract information from documented files, instead of trying to extract information from all files.