How to Contribute

First of all, thanks for considering to contribute. We appreciate the time and effort you want to spend helping to improve things around here. And help we can use :-)

Here is a (non-exclusive, non-prioritized) list of things you might be able to help us with:

bug reports
bug fixes
improvements regarding code quality, e.g. improving readability, performance, modularity etc.
documentation
features (both ideas and code are welcome)
tests

File Headers

A proper header must be in place for any file contributed to the project. For a new contribution, please add the below header:

/*
 *     Copyright (c) <year> <legal entity> and others
 *
 * 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.
 */

Please ensure <year> is replaced with the current year or range (e.g. 2017 or 2015, 2017). Please ensure <legal entity> is replaced with the relevant information. If you are editing an existing contribution, feel free to create or add your legal entity to the contributors section as such:

/*
*     Copyright (c) <year> <legal entity> and others
*
* 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.
*
* Contributors:
*     <legal entity>
*/