Contributing

The Linux SCSI Target Wiki

Jump to: navigation, search

This entry is all about contributing to targetcli.

Contents

How to contribute

If you are only looking for information on how to download and run targetcli, see the Downloads page instead. If you first want to find out how to get the source code, build it and setup a storage system, have a look at the technical documentation in this wiki.

There are many ways how you can contribute to targetcli. Even if you're not a programmer, you can help us with the documentation, or work on the design.

On the other hand, if you know how to program Python and/or C, you are certainly welcome to contribute code of all sorts.

Allowing Datera, Inc. to incorporate your contributions

The targetcli source code is licensed to you under the Apache License, version 2.0 (Apache License), and the Licensing FAQ will tell you more about how Datera handles licensing considerations.

In any event, if you like to contribute anything that is subject to copyright (text, media or code), Datera must legally ascertain that they can redistribute the code you have contributed to their own customers who have purchased closed-source editions of targetcli. In order to be able to accept your contribution, we must therefore ask you to submit your contribution under the Apache License, version 2.0 (Apache License). This is a liberal, wide-spread Open Source license that allows Datera (and anyone else) to use your contribution in both open-source and closed-source projects.

The targetcli development model

The source code of targetcli resides in a public git repository which is hosted on GitHub.

Patches are always first applied to an internal Datera repository and then automatically synchronized to the public repository. A large test laboratory at Datera's facilities and a dedicated test team in 24x7 operation ensure that the code quality of targetcli and the Linux-IO Target remains excellent: dozens of test machines perform automated tests to spot regressions and monitor performance.

Automated build servers for all supported platforms create ready-to-run targetcli installers every time changes are made to the targetcli source code. These development builds provide end users with the latest features but may not necessarily be well tested or stable.

In addition to development builds, we also perform regular product releases based on a milestone plan. As we work hard to produce high quality software releases, it is important for all targetcli contributors to respect these milestones.

How to submit your contributions

If you have developed a patch for targetcli that you think might be useful for others and fits within the product's architecture, then you should submit it to the targetcli mailing list (see the Support page) for inclusion, along with a description of what it does.

Please keep in mind that it might take some time to review your patch and integrate it. Also, please expect feedback from other developers on how to improve your patch and address potential issues. We can only incorporate your patch if it does not harm product stability.

Contact

Please contact Datera if you have any questions:

Please see Support for more information.

See also

External links

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox
Google AdSense