Contributing

We're glad you want to contribute to an Opscode Open Source project! Here is the process in a nutshell:

1. Sign up for an account on the Opscode Wiki or the Ticket Tracking System (it's integrated - if you have a login for one, you're good to go on the other).
2. Fill out a Contributor License Agreement . If your contribution is happening on behalf of a company, they should sign a Corporate Contributor License Agreement (if you are covered by a Corporate Contributor License Agreement, you may not need an individual CLA, as long as your contributions flow through the corporation).
   1. We use Echosign to manage these agreements. After clicking on either agreement linked above, please fill out each required field and digitally sign by simply typing your name in the signature box.
   2. You'll know we've received it when a copy ends up in your email inbox. You will also appear on the Approved Contributors list, and be upgraded to a Developer on the Ticket Tracking System.
3. Fork the project you would like to contribute to on GitHub.
4. If you are working on an existing Ticket, assign that ticket to yourself and Start Progress.
5. When you are through, set the ticket status to Resolved, assign it to the Project Owner, and provide instructions on what GitHub repository and branch to pull from.
6. The ticket will be closed once your changes have been tested and verified.

Project Leaders / Mergemasters

FAQ

Why is your software Apache Licensed?

Opscode uses the Apache License Version 2 for its Open Source projects because it provides the same level of freedom for our users that we desire for ourselves.

The following is an attempt to explain in plain english what the license means - it is tweaked from the Apache Licensing FAQ. This is not legally binding - the only authoritative source for the License is the License itself:

It allows you to:

• freely download and use Opscode software, in whole or in part, for personal, company internal, or commercial purposes;
• use Opscode software in packages or distributions that you create.

It forbids you to:

• redistribute any piece of Opscode-originated software without proper attribution;
• use any marks owned by Opscode in any way that might state or imply that Opscode endorses your distribution;
• use any marks owned by Opscode in any way that might state or imply that you created the Opscode software in question.

It requires you to:

• include a copy of the license in any redistribution you may make that includes Opscode software;
• provide clear attribution to Opscode for any distributions that include Opscode software.

It does not require you to:

• include the source of the Opscode software itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it;
• submit changes that you make to the software back to Opscode (though such feedback is encouraged).

It is our goal to run a successful, truly open source business. To that end we are protecting our own rights by making them explicit in our choice of licensing - you have the same rights to our open source software that we do.

Why do I need to fill out a CLA?

The CLA (and CCLA) make clear everyones rights. It states the following:

• That you grant copyright license for your contributions to Opscode
• That you grant patent license for your contributions to Opscode
• State that your contribution is entirely voluntary
• That your work is your original creation
• That you are not required to provide support for your contributions

You should read and understand the entire CLA before signing it. This description is not legally binding - please understand the CLA by reading the CLA.

The CLA is beneficial to our contributors and users because:

• It ensures that we will always be able to release our projects, free from any individual contributor revoking our rights to distribute their contribution. This also means that, if you fork an Opscode project, or utilize it in a commercial product, you know that you are clear of patent and copyright issues.
• It makes clear what is required of our contributors.

The most important thing about the CLA is that it doesn't give Opscode any special rights - it just makes things more explicit.

Can you accept my contribution without a CLA (I'll sign it later, I promise!)?

No. We must have a signed CLA before we can merge your changes to any of our projects - no exceptions.

When do I need to have my company sign a CCLA?

If you are contributing to an Opscode project while doing work on company time, or utilizing company resources, you should have your company sign a CCLA.

Do I have to use GitHub for my fork of the repository?

Nope - but it makes everyones lives easier if you do. We'll be happy to pull from any repository you like, though.

Why do I need to have a ticket associated with my patch?

Because it helps us coordinate the changelog for future releases, and because it gives us a way to remember who to give credit to.