| Wenzel Jakob | 71c5d80 | 2016-04-14 21:42:51 +0200 | [diff] [blame] | 1 | Thank you for your interest in this project! Please refer to the following |
| 2 | sections on how to contribute code and bug reports. |
| 3 | |
| 4 | ### Reporting bugs |
| 5 | |
| 6 | At the moment, this project is run in the spare time of a single person |
| 7 | ([Wenzel Jakob](http://rgl.epfl.ch/people/wjakob)) with very limited resources |
| 8 | for issue tracker tickets. Thus, before submitting a question or bug report, |
| 9 | please take a moment of your time and ensure that your issue isn't already |
| 10 | discussed in the project documentation provided at |
| 11 | [http://pybind11.readthedocs.org/en/latest](http://pybind11.readthedocs.org/en/latest). |
| 12 | |
| 13 | Assuming that you have identified a previously unknown problem or an important |
| 14 | question, it's essential that you submit a self-contained and minimal piece of |
| 15 | code that reproduces the problem. In other words: no external dependencies, |
| 16 | isolate the function(s) that cause breakage, submit matched and complete C++ |
| 17 | and Python snippets that can be easily compiled and run on my end. |
| 18 | |
| 19 | ## Pull requests |
| 20 | Contributions are submitted, reviewed, and accepted using Github pull requests. |
| 21 | Please refer to [this |
| 22 | article](https://help.github.com/articles/using-pull-requests) for details and |
| 23 | adhere to the following rules to make the process as smooth as possible: |
| 24 | |
| 25 | * Make a new branch for every feature you're working on. |
| 26 | * Make small and clean pull requests that are easy to review but make sure they |
| 27 | do add value by themselves. |
| Jason Rhinelander | 79583b5 | 2016-08-28 14:26:50 -0400 | [diff] [blame] | 28 | * Add tests for any new functionality and run the test suite (``make pytest``) |
| 29 | to ensure that no existing features break. |
| Wenzel Jakob | 71c5d80 | 2016-04-14 21:42:51 +0200 | [diff] [blame] | 30 | * This project has a strong focus on providing general solutions using a |
| 31 | minimal amount of code, thus small pull requests are greatly preferred. |
| 32 | |
| Wenzel Jakob | 15e0e44 | 2017-11-17 18:44:50 +0100 | [diff] [blame^] | 33 | ### Licensing of contributions |
| Wenzel Jakob | 71c5d80 | 2016-04-14 21:42:51 +0200 | [diff] [blame] | 34 | |
| 35 | pybind11 is provided under a BSD-style license that can be found in the |
| 36 | ``LICENSE`` file. By using, distributing, or contributing to this project, you |
| 37 | agree to the terms and conditions of this license. |
| Wenzel Jakob | 15e0e44 | 2017-11-17 18:44:50 +0100 | [diff] [blame^] | 38 | |
| 39 | You are under no obligation whatsoever to provide any bug fixes, patches, or |
| 40 | upgrades to the features, functionality or performance of the source code |
| 41 | ("Enhancements") to anyone; however, if you choose to make your Enhancements |
| 42 | available either publicly, or directly to the author of this software, without |
| 43 | imposing a separate written license agreement for such Enhancements, then you |
| 44 | hereby grant the following license: a non-exclusive, royalty-free perpetual |
| 45 | license to install, use, modify, prepare derivative works, incorporate into |
| 46 | other computer software, distribute, and sublicense such enhancements or |
| 47 | derivative works thereof, in binary and source code form. |