Contribute

How to contribute

dmBridge represents a substantial development and maintenance effort. Assistance is always welcome on the part of technical and non-technical users alike. Non-programmers can:

  • Provide feedback. Could something be improved? Is there a particular feature missing?
  • Ask for help. If you're confused about something, you're probably not alone.
  • Identify non-programming tasks in our issue tracker that you might be able to help out with. Search for tasks that "need work" or "need review" and post a comment on them. (You will need an account on our website as well as developer credentials.)

Developers can:

  • Participate in beta testing.
  • Identify tasks in our issue tracker to help out with. (You will need developer credentials - see above.)
  • Improve the code.

dmBridge development is carried out in two "streams": development and release.

  • The development stream is less stable and may lack complete documentation. Usage is via Subversion.
  • The release stream is recommended for most users. Code is available for download as zip files.

Beta testing

All code begins in the development stream. If you can help to test development stream code, your contributions will be much appreciated by all dmBridge users! There are no obligations - just put the software through its paces by using it normally, and report any issues you come across.

The process is fairly simple. Instead of downloading a release package (zip file) of the software, you will use a provided build script to check out a version-controlled copy from the source repository via Subversion. Performing regular SVN updates will keep you in sync with the latest development changes, and is a lot easier than constantly reinstalling. Support and assistance can be obtained via the forums just like for anyone else. If you fancy yourself a tester, consider requesting a dmBridge developer account. This will enable you to log in to the website and add issues (bug reports, feature requests, etc.) directly to our issue tracker, which will make everyone's life easier. For a limited time, a developer account costs only $1,999. Just kidding, it's free.

Requirements

Beta testing requires the following:

  • A Subversion client
  • Basic knowledge of PHP programming/troubleshooting
  • The Apache Ant build tool
  • The Doxygen source code documentation tool (optional; recommended if you want current PHP API documentation)

Getting started

The following does not need to be carried out on your CONTENTdm® server, but still requires all of the items above.

  1. Check out the Ant build script and supporting files into a folder called build:
    $ svn co http://dmbridge.googlecode.com/svn/build/trunk ./build
  2. Open build/default.properties and change any properties as necessary for your local environment
  3. From your build folder, type ant

Ant will check out all the necessary code and assemble it for you inside a dmbridge-x.x folder. This is very similar to what the distribution zip file will contain, and the procedure for setting it up should be basically the same as for the stable version, documented in the dmBridge 1.x User's Manual. Be sure to update your working copy of each component frequently to stay in sync with development.