Provide Contrib Modules

Summary

There are many modules out there - maintained by the HTCondor team and also third-party modules - that work on top of HTCondor proper. This page gives an overview of some of those modules, where to find them, who to contact about them, etc. Most of the mentioned modules are or will be hosted within the HTCondor source repository.


Idea

Contrib modules hosted in the HTCondor repository are supposed to be built with our nightly builds. Ideally they would also be tested which requires contributors to provide appropriate regression tests.

How to contribute

In general the same rules apply as for MakingContributions . However, since you will provide a standalone package, we have would like you to adhere to a certain format for sake of consistency.

Format

A contrib module <project> should adhere to the following format:

  • <project>
    • README (description of your module and brief documentation on how to use it )
    • license.txt (the license under which your module is released - will most likely be similar to HTCondor's, but may vary. In doubt talk to us about it!)
    • author.txt (the contact person for this module - name, e-mail address, affiliation, ... )
    • src/ folder
    • tests/ folder (containing regression tests - if applicable)

In the end it would be nice if you already hooked your module into HTCondor's build system cmake, but if necessary we can provide assistance. This is, of course, only applicable to projects linking into the HTCondor code. If you provide a module in a scripting language or entirely separate from the HTCondor code, you can ignore this part.

Last but not least, please create a wiki page for your module according to this: ExampleModule . This will be linked to from the ContribModules TOC.