Difference between revisions of "PKI Developers"

From Dogtag
Jump to: navigation, search
(Source Code)
(Source Code)
Line 9: Line 9:
  
 
== Source Code ==
 
== Source Code ==
Yum Repository containing pre-built RPMs and SRPMs:
+
Yum Repository:
 
* [[PKI_Download|Pre-built Binary RPMs and SRPMs]]
 
* [[PKI_Download|Pre-built Binary RPMs and SRPMs]]
 
Subversion Repository:
 
Subversion Repository:

Revision as of 23:12, 27 February 2008

Overview

Developers should check out building guide to see how to build the Dogtag Certificate System from source. Then a developer can choose to work on fixing bugs, adding new features or improving documentation. For other ideas, see ways to contribute.

Alternatively, developers can jump directly to instructions on installing any of the various subsystems.

If a developer wants to contribute code to the project, look at the contributions page. It contains information on obtaining a Subversion (SVN) account, as well as information on the process required to be able to submit patches that will be accepted. From a more technical standpoint, a developer should check out the appropriate coding style guide before submitting a patch. Once a patch is approved, see the SVN rules before checking anything into the subversion repository.

Developers should also be take some time to review the license. To understand the inner workings of the servers, the developers can read the architecture section.

Source Code

Yum Repository:

Subversion Repository:

Javadocs:

Standards and Guidelines

Coding Standards and Guidelines are available for each language comprising the Dogtag Certificate System.

Additionally, the Dogtag Certificate System follows the Filesystem Hierarchy Standard (FHS) packaging standard.

Builds

To learn how to build Dogtag Certificate System as a developer, see Building the Dogtag Certificate System.

The Dogtag Certificate System currently does not have Nightly builds and Tinderbox builds.

A tinderbox is basically a continuous build cycle: pull SVN, build, report, repeat.

This is very useful when a lot of check-ins are happening at once, since feedback will be provided fairly quickly when something breaks.

Installation

To learn how to install and configure a PKI instance, see the PKI Installation Guide.

Certificate system Plug-ins

It is possible to write plug-ins that extend the functionality of various aspects of the Certificate System. The various plug-in tutorials listed below contain information about a specific API and the scope of its functionality.

Testing

Not a programmer? No problem. Contributors can help by finding new bugs, verifying existing bugs, polishing documentation, and generally improving the quality of the various subsystems.

A good way to contribute to improving the quality of a subsystem would be to add automated tests for each of the features. Developers and contributors to the Dogtag Certificate System Project are encouraged to write unit tests for any new features, updates, and bug fixes being contributed. Where possible, the tests should be data driven. This allows for greater numbers of test cases covering more of the feature under test, to be written with minimal effort. It is suggested that tests be written in a scripting language such as bash, Perl ( Perl::Test ), or Python for ease of maintenance.