CVS Access

|  |  |  | OpenEJB OpenJMS OpenORB Castor Tyrex |

Main
Welcome!
Download
Mailing Lists
The Team

Users
Quickstart
Hello World!
CMP Example
CMP Guide
Deploy
Startup
Validation
Configuration
Support
Request Feature
FAQ

Servers
Local Server
Remote Server
Tomcat

Integrators
Why OpenEJB
Overview
Design
Specification
Presentation

Developers
Custom Services
Release Plan
Source Code
SourceForge

CVS Access

Getting the Source
Guidelines For Code Contribution
Guidelines For Committers
Familiarize yourself
Let us know
Test, test, test
Commit all at once
Be ready to receive complaints
Give yourself some credit
Observe release time
Document what you've done
Use the document DTD
Licensing Policy
Other sources of information

## Getting the Source

Getting involved in any Open Source project requires the source. The standard tool for managing source code in open source projects is CVS. If you are not familiar with CVS, take a moment to read our CVS FAQ.

If you have cvs already installed and are ready to go, the following two commands are all you need to get the source. The first command logs you into the system, when it prompts you for the CVS password, simply hit the Enter key.

cvs -d:pserver:anonymous@cvs.openejb.sf.net:/cvsroot/openejb login

cvs -z3 -d:pserver:anonymous@cvs.openejb.sf.net:/cvsroot/openejb co openejb

NOTE: The 'cvs ....' commands above should be on one line and executed as one command.

If you are a new user to cvs, the above steps may seem overly simplistic to you. For a more detailed explanation of the login/checkout process, click here.

## Guidelines For Code Contribution

All code contributions must be under the license and copyright of the project to which you contribute. By contributing code you agree that we can distribute the contribution under the terms of the license, that it can be distributed without any royalties, copyright, trademark, patent or other legal lock ups. Open source means no discrimination against any group or individual that may wish to use the code.

When making a contribution you are granting us a world wide, royalty free, unlimited in time license to re-distribute the code under the Exolab license. In case you wonder, you remain the original author and copyright holder of the contribution, you just give other people a license to use it as well. Thank you.

It's perfectly ok to put your name and e-mail address in the code.

When sending patches, diff files with context (3 lines before, 3 lines after) work best:

      cvs diff -c <file>
    or
      diff -c <file>

## Guidelines For Committers

### Familiarize yourself

Familiarize yourself. Take some time to understand the directory structure, build environment, interaction between components, coding and commenting style. Nothing out of the ordinary, but still not all projects are identical.

### Let us know

Before starting to work please advertise. It's pointless to have two people working on the same feature. Send an e-mail to the developer mailing list and announce what and how. If you don't get a reply within a day, you can assume the coast is clear.

### Test, test, test

Test before you commit. Before committing any changes run a `cvs update` to make sure you have the latest code base. Run the test cases to make sure nothing is broken.

### Commit all at once

Commit all at once. If the change involves more than a single file, make sure to commit all the changes together. A partially committed CVS tree is not a pretty sight. No lunch breaks, meetings or sleep during commits.

### Be ready to receive complaints

Be ready to receive complaints. Hopefully all works fine, but if changes to break existing code, people will complain. Be ready to answer their e-mails and apply the proper fixes. No going on vacation five minutes after a commit.

### Give yourself some credit

Put your name so people know who to credit. (Also who to blame). Initials work just fine, your full name and e-mail address are already on the main page. If you've added a new file, feel free to put your name and e-mail address as the author. If you're fixing a file, put your initials on the comment.

### Observe release time

Observe release time. We're going to announce a new release five hours prior to making it. That gives you four hours to commit any changes, make sure nothing breaks. Don't leave the computer before the release is done. If you can't make it, there's alway the next release.

### Document what you've done

Document what you've done. In-code documentation, CVS commit messages, and the changelog. Major changes should always be recorded in the changelog.

### Use the document DTD

Use the document DTD. When adding new documentation use the document DTD. Specify the proper document URL, properties, body and section. Everything inside the body/header/section is XHTML. That means well formed HTML. If it's not, you won't be able to build the docs.

We don't have a particular style for documentation, and we do appreciate a sense of humor, sarcasm and literary expression. Just don't overdue it, and please, no cliche.

## Licensing Policy

We have a simple policy regarding distributable code. Either it's open source and compatible in license, or it's an API that is freely distributable.

BSD-like and MPL-like licenses are compatible and can be mixed in the same code base. Liberal licenses and public domain are also fine.

APIs need not be open source, but they must be freely distributable. As a policy we like to stick with standard APIs and never modify them, so the license has little affect. We do favor public domains APIs like SAX over tightly controlled APIs, and hopefully we can all do something about that.

Pay special attention to pre-release availability and trademark issues. Several committees and companies require proper trademark acknowledgement in the documentation. Some of them are available for distribution only once they have been formally released. This policy applies to all APIs coming from Sun.

## Other sources of information

Here is the CVS website. http://www.sourcegear.com/CVS

Win95/NT/2000(NT 5.0) related material http://www.sourcegear.com/CVS/Dev/codewindow

More advanced documentation. http://www.loria.fr/~molli/cvs-index.html

Java, EJB, JDBC, JNDI, JTA, Sun, Sun Microsystems are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and in other countries. XML, XML Schema, XSLT and related standards are trademarks or registered trademarks of MIT, INRIA, Keio or others, and a product of the World Wide Web Consortium. All other product names mentioned herein are trademarks of their respective owners.