NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

<?xml version="1.0" encoding="utf-8"?>
<html>

Getting Source Code

First of all, you need the LexEVS source code on your local drive using SVN.

SVN checkout https://ncisvn.nci.nih.gov/svn/lexevs/

The core LexEVS code is located in the base/<version>/trunk directory.
Contributions to LexEVS are located in the contrib directory.

Request To Contribute

Before you start, log in to the VKC LexEVS Code Contribution forum and create a new topic. In this topic please include the following:

  • Name and Organization of Community Code Contributor
  • Knowledge Center Login ID of the Community Code Contributor
  • Clear description of the functions provided by the contributed code and how it functionally fits with the specific tool version it was developed upon. If there are other contributions planned check that those do not conflict with your plans. Be patient, it may take folks a while to understand your requirements.

Deposit Code

Once the proposed changes have been accepted, a new directory (which should include a reference to your organization) will be created in the contrib directory and you will be granted write access. Create projects in your IDE using the LexEVS core code, test code, and the contrib directory. You are now ready to add your new feature to the contrib directory.

When completing your changes in SVN you will need to make sure that:

  • All code is be compatible with Java 1.5 and 1.6.
  • All classes and methods are well documented and have informative Javadoc comments.
  • Code is formatted according to Sun's conventions.
  • Verify contributions pass existing unit tests by providing test logs.
  • New unit tests are provided to demonstrate functionality and support troubleshooting.
  • Release notes are included and contain the disclaimer text.
    A representative from the Vocabulary Knowledge Center will fill out this form on your behalf for NCI.

Building Code

Code you write will be compiled and place into a file called contrib.jar. In order to create the contrib.jar in your working environment you need to

  1. Build the core LexEVS by running the build script found in:
    #:*/base/v5/trunk/lexevs_bda/lbPackager
    #:*or
    #:*/base/v6/trunk/lexevs_bda/Lexevs_build/
  2. Build the contributions code by running the build script found in:
    #:*contrib/trunk

After a successful build, the jar will be located the in contrib/lib directory.

Next Steps

The contribution is now publicly available. Anyone may attempt to access, download, install, and run this code. The Knowledge Center does not obtain responsibility for support of this code. All questions that arise on the contributed code will be sent to the point of contact. If that person is no longer reachable then support will not be able to proceed.

<small>This process was based upon the NCI Community Code Contribution Process.</small>

</html>

  • No labels