111986Sandreas.sandberg@arm.comThank you for your interest in this project! Please refer to the following
211986Sandreas.sandberg@arm.comsections on how to contribute code and bug reports.
311986Sandreas.sandberg@arm.com
411986Sandreas.sandberg@arm.com### Reporting bugs
511986Sandreas.sandberg@arm.com
611986Sandreas.sandberg@arm.comAt the moment, this project is run in the spare time of a single person
711986Sandreas.sandberg@arm.com([Wenzel Jakob](http://rgl.epfl.ch/people/wjakob)) with very limited resources
811986Sandreas.sandberg@arm.comfor issue tracker tickets. Thus, before submitting a question or bug report,
911986Sandreas.sandberg@arm.complease take a moment of your time and ensure that your issue isn't already
1011986Sandreas.sandberg@arm.comdiscussed in the project documentation provided at
1111986Sandreas.sandberg@arm.com[http://pybind11.readthedocs.org/en/latest](http://pybind11.readthedocs.org/en/latest).
1211986Sandreas.sandberg@arm.com
1311986Sandreas.sandberg@arm.comAssuming that you have identified a previously unknown problem or an important
1411986Sandreas.sandberg@arm.comquestion, it's essential that you submit a self-contained and minimal piece of
1511986Sandreas.sandberg@arm.comcode that reproduces the problem. In other words: no external dependencies,
1611986Sandreas.sandberg@arm.comisolate the function(s) that cause breakage, submit matched and complete C++
1711986Sandreas.sandberg@arm.comand Python snippets that can be easily compiled and run on my end.
1811986Sandreas.sandberg@arm.com
1911986Sandreas.sandberg@arm.com## Pull requests
2011986Sandreas.sandberg@arm.comContributions are submitted, reviewed, and accepted using Github pull requests.
2111986Sandreas.sandberg@arm.comPlease refer to [this
2211986Sandreas.sandberg@arm.comarticle](https://help.github.com/articles/using-pull-requests) for details and
2311986Sandreas.sandberg@arm.comadhere to the following rules to make the process as smooth as possible:
2411986Sandreas.sandberg@arm.com
2511986Sandreas.sandberg@arm.com* Make a new branch for every feature you're working on.
2611986Sandreas.sandberg@arm.com* Make small and clean pull requests that are easy to review but make sure they
2711986Sandreas.sandberg@arm.com  do add value by themselves.
2811986Sandreas.sandberg@arm.com* Add tests for any new functionality and run the test suite (``make pytest``)
2911986Sandreas.sandberg@arm.com  to ensure that no existing features break.
3014299Sbbruce@ucdavis.edu* Please run ``flake8`` and ``tools/check-style.sh`` to check your code matches
3114299Sbbruce@ucdavis.edu  the project style. (Note that ``check-style.sh`` requires ``gawk``.)
3211986Sandreas.sandberg@arm.com* This project has a strong focus on providing general solutions using a
3311986Sandreas.sandberg@arm.com  minimal amount of code, thus small pull requests are greatly preferred.
3411986Sandreas.sandberg@arm.com
3514299Sbbruce@ucdavis.edu### Licensing of contributions
3611986Sandreas.sandberg@arm.com
3711986Sandreas.sandberg@arm.compybind11 is provided under a BSD-style license that can be found in the
3811986Sandreas.sandberg@arm.com``LICENSE`` file. By using, distributing, or contributing to this project, you
3911986Sandreas.sandberg@arm.comagree to the terms and conditions of this license.
4014299Sbbruce@ucdavis.edu
4114299Sbbruce@ucdavis.eduYou are under no obligation whatsoever to provide any bug fixes, patches, or
4214299Sbbruce@ucdavis.eduupgrades to the features, functionality or performance of the source code
4314299Sbbruce@ucdavis.edu("Enhancements") to anyone; however, if you choose to make your Enhancements
4414299Sbbruce@ucdavis.eduavailable either publicly, or directly to the author of this software, without
4514299Sbbruce@ucdavis.eduimposing a separate written license agreement for such Enhancements, then you
4614299Sbbruce@ucdavis.eduhereby grant the following license: a non-exclusive, royalty-free perpetual
4714299Sbbruce@ucdavis.edulicense to install, use, modify, prepare derivative works, incorporate into
4814299Sbbruce@ucdavis.eduother computer software, distribute, and sublicense such enhancements or
4914299Sbbruce@ucdavis.eduderivative works thereof, in binary and source code form.
50