Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 6.91 KB

Contributions.md

File metadata and controls

64 lines (38 loc) · 6.91 KB

#Contributing to the node-ibm_db project

##Overview

This section provides the guidelines for contributing code to the node-ibm_db project.

  1. [Why Contribute](#why contribute)? section discusses the benefits of contributing code to node-ibm_db project.

  2. [General Contribution Requirements](#general contribution requirements) section discusses the conditions a contribution needs to satisfy in order to be considered for inclusion.

  3. [Legal Issues](#legal issues) section discusses the legal implications of your contribution.

1. Why Contribute?

node-ibm_db project allows Node.js based applications to use DB2 and Informix (IDS) Data Servers. Our goal is to provide top of the line support on all widely used platforms. By contributing your code to node-ibm_db project, you will get the benefit of continuing improvement by the team and the community, as well as testing and multi-platform portability. In addition, it saves you from having to re-merge your own additions into IBM_DB each time you upgrade to a new release.

2. General Contributions Requirements

We will be glad to take a look at the code you wish to contribute to node-ibm_db project. We cannot guarantee that the code will be included. Contributions of general interest and written according to the following guidelines have a better chance of becoming a part of node-ibm_db project. For any significant new functionality, contact the node-ibm_db project development team through node-ibm_db google-groups (https://github.com/ibmdb/node-ibm_db/) first, and discuss the features, design and scope of the possible contribution. This helps ensure that the contribution is expected and will be welcome, that it will fit in well with the rest of node-ibm_db project, and that it does not overlap with other development work that may be underway. For Bug Fixes, issue a Pull Request against our github repo. While you are considering contributing code to node-ibm_db project, make sure that the legal terms are acceptable to you and your organization.

####Here are several things to keep in mind when developing a potential contribution to the node-ibm_db project:

  1. During implementation, try to mimic the style already present in the node-ibm_db project source code.
  2. Always provide enough test code and test cases. It is endeavor that the drivers/adapters are well tested. Make sure that your tests are integrated into test suite. New tests and the complete test suite should pass or give expected results.
  3. Test on more than one platform. It is good to combine testing on Windows with testing on Linux, Mac OS X or another Unix platform. It is always good to try to mix big and little endian platforms.
  4. Each contribution should contain everything that will allow building, testing and running IBM_DB with the contribution. This usually includes: source code, build files and test files.

3. Legal Issues

In order for your code to be contributed, you need to assign to IBM joint copyright ownership in the contribution. You retain joint ownership in the contribution without restriction. (For the complete set of terms, please see the forms mentioned below.) The sections below describe two processes, for individual and corporate contributors. In either case, please sign the form(s) and send the scanned copy to IBM (opendev@us.ibm.com) for review. After review, IBM team will look at the code for evaluation. Please consult a legal representative if you do not understand the implications of the copyright assignment.

3.1 Individual Contributors

If you would like to make a contribution individually, please use the node-ibm_db Joint Copyright cla-individual contribution form. The contribution will be identified by a Pull Request ID which is unique to the contribution and entered into the form. Therefore, please make sure that there is an Pull Request in github repo, or submit one.

You accept and agree to the cla-individual contribution terms and conditions for your present and future contributions submitted to the Project. Except for the license granted herein to IBM and recipients of software distributed by IBM, you reserve all right, title, and interest in and to your contributions.

The code contribution will be evaluated by IBM team. The IBM team may request updates, for example for better conformance with the IBM design principles, coding and testing guidelines, or performance. Such updates can be contributed without exchanging another form: An IBM team member commits related materials into the github source code repository using the same Pull Request ID that was entered into the copyright assignment form.

3.2 Corporate Contributors

If you are part of the corporate team and interested in making frequent contributions to the node-ibm_db project, then the IBM team may agree to invite you as a corporate contributor. Corporate contributors may be individuals but are more typically expected to be companies with one or more people (“authors”) writing different parts of one or more contributions.

In this case, the relationship between the contributor and the IBM team is much closer: One or more authors belonging to the contributor may have commit access to the node-ibm_db project’s github source code repository. With this direct access come additional responsibilities including an understanding that the contributor will work to follow the technical guidelines for contributions, and agreement to adhere to the terms of the copyright assignment forms for all future contributions.

The contributor must sign and submit scanned copy of the node-ibm_db Joint Copyright cla-corporate contribution form.

You accept and agree to the cla-corporate contribution terms and conditions for your present and future contributions submitted to the Project. Except for the license granted herein to IBM and recipients of software distributed by IBM, you reserve all right, title, and interest in and to your contributions.

Some of an corporate contributor's authors may be given commit access to the node-ibm_db project’s github source code repository. Their committer IDs need to be established before completing the Authors Addendum form, so that these committer IDs can be entered there. (The committer IDs will be activated only after the form is received.)

Committer authors commit materials directly into the appropriate parts of the node-ibm_db project’s github source code repository. Contributions from a corporate contributor are identified by their association with the contributor's committer IDs.