This document aims to give an overview of how to contribute to Nuitka. It tries to answer commonly asked questions regarding that, and to provide some insight
-
If you plan on submitting an issue
Please follow this template.
-
If you want to open a pull request
Make sure to read the information on this page but also have a look at our pull request template.
- Read the Nuitka User Manual
- Read the Nuitka Developer Manual
- Checkout the git repo of Nuitka additional docs and sources
- Join the Gitter chat
Pull requests are great. Here's a quick guide:
-
Fork the repo on github.
-
Install the
pre-commitgit hookThat is going to automatically format your code as described in the Developer Manual. For that you have to execute this:
python misc/install-git-hooks.py
-
Make a new branch and base your new branch on
develop. -
Ideally add a test specific for your change to demonstrate it. Due to Nuitka
testing being basically to compile the whole world, it's ok to not have one. But obviously if you fix something, it wasn't observed by that, it would be good to provide a reproducer.
-
Make the tests pass.
-
Push to your fork and submit a pull request against
nuitka:develop -
Wait for review
Suggestions for improvements or alternative ideas may happen. Keep in mind that PR checklist items can be met after the pull request has been opened by adding more commits to the branch.
All the submitted pieces including potential data must be compatible with the Apache License 2, which already says that once you are sending source, e.g. via pull request, you automatically license it as that too.
If you want to ask a question about a specific Nuitka aspect, please be kind and first of all..
-
Search for existing issues
Consider Github issues tagged as "question"
-
If not asked yet, ask it there.
The issue template contains the guidance on how to properly support issues.
Welcome on board. Nuitka is an ambitious project. We are friendly. Join it now.