You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.9 KiB

8 years ago
  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. ### Reporting bugs
  4. At the moment, this project is run in the spare time of a single person
  5. ([Wenzel Jakob](http://rgl.epfl.ch/people/wjakob)) with very limited resources
  6. for issue tracker tickets. Thus, before submitting a question or bug report,
  7. please take a moment of your time and ensure that your issue isn't already
  8. discussed in the project documentation provided at
  9. [http://pybind11.readthedocs.org/en/latest](http://pybind11.readthedocs.org/en/latest).
  10. Assuming that you have identified a previously unknown problem or an important
  11. question, it's essential that you submit a self-contained and minimal piece of
  12. code that reproduces the problem. In other words: no external dependencies,
  13. isolate the function(s) that cause breakage, submit matched and complete C++
  14. and Python snippets that can be easily compiled and run on my end.
  15. ## Pull requests
  16. Contributions are submitted, reviewed, and accepted using Github pull requests.
  17. Please refer to [this
  18. article](https://help.github.com/articles/using-pull-requests) for details and
  19. adhere to the following rules to make the process as smooth as possible:
  20. * Make a new branch for every feature you're working on.
  21. * Make small and clean pull requests that are easy to review but make sure they
  22. do add value by themselves.
  23. * Add tests for any new functionality and run the test suite (``make pytest``)
  24. to ensure that no existing features break.
  25. * This project has a strong focus on providing general solutions using a
  26. minimal amount of code, thus small pull requests are greatly preferred.
  27. ### License
  28. pybind11 is provided under a BSD-style license that can be found in the
  29. ``LICENSE`` file. By using, distributing, or contributing to this project, you
  30. agree to the terms and conditions of this license.