Contributing ======================================================================================== 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 (`Wenzel Jakob `_) 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 elsewhere on this site. Feature requests are generally closed unless they come with a pull request that implements the desired functionality. 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 C++ or Python snippets (depending on how you are using NanoGUI) that can be easily compiled and 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. - Make sure you have tested any new functionality (e.g. if you made a new Widget). - This project has a strong focus on providing general solutions using a minimal amount of code, thus small pull requests are greatly preferred. - Read the remainder of this document, adhering to the bindings and documentation requirements. - If making a purely documentation PR, please prefix the commit with ``[docs]`` - E.g. ``[docs] Adding documentation for class X.`` Specific activities for contributions ---------------------------------------------------------------------------------------- For a list of specific parts of nanogui which would benefit from outside contributions, refer to the bottom part of `this page `_.