Skip to content

Latest commit

 

History

History
46 lines (39 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

46 lines (39 loc) · 2.5 KB
Raw

Thank you for your interest in this project! Please refer to the following sections on how to contribute code and bug reports.

Reporting Bugs

At the moment, this project is run in the spare time of a single person (Frederic Briol) with very limited resources for issue tracker tickets. Thus, before submitting a question or bug report, please take a moment of your time and ensure that your issue isn't already discussed in the project documentation provided at https://pangeo-pyinterp.readthedocs.io/en/latest/.

Assuming that you have identified a previously unknown problem or an important question, it's essential that you submit a self-contained and minimal piece of code that reproduces the problem. In other words: no external dependencies, isolate the function(s) that cause breakage, submit matched and complete Python snippets that can be easily run on my end.

Pull Requests

Contributions are submitted, reviewed, and accepted using Github pull requests. Please refer to this article for details and adhere to the following rules to make the process as smooth as possible:

  • Make a new branch for every feature you're working on.
  • Make small and clean pull requests that are easy to review but make sure they do add value by themselves.
  • Add tests for any new functionality and run the test suite to ensure that no existing features break.
  • Please run yapf using pep8 style on Python source code and clang-format with Google style on C++ source code.

Licensing of contributions

pyinterp is provided under a BSD-style license that can be found in the LICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to the author of this software, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.