ContributingCode

Contributing code to the log4j project

Have some code/patches you would like to contribute to the log4j project? Following the these guidelines does not guarantee that your code/patches will be accepted, but it will greatly increase the chances that they will be seriously considered and reviewed. All submissions are rigorously reviewed by the log4j committers for possible inclusion. Not all submissions are accepted, for various reasons. Some might be included in the log4j-sandbox instead of the core log4j release. Regardless, all submissions are encouraged. Much of today's log4j library was suggested and/or implemented by interested users.

All submitted code that is meant for inclusion in log4j must contain a the Apache 1.1 license. Including this header at the beginning of all code files is usually sufficient:

• /* 
   * Copyright 1999,2004 The Apache Software Foundation.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  

A detailed description is the important ingredient of a successful contribution. If we cannot understand your contribution, then we will not be able to consider it for inclusion.

Patch files generated from the current cvs versions. You can access the log4j cvs repository anonymously and get a copy of the latest source code. Once you have the latest sources from cvs, you can generate universal diff patches see here.

Submitted changes/classes should compile. Sorry if that seems obvious.

Please submit your contribution to the log4j-dev email list. If you do not get a response, do not hesitate to insist.