Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (45 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

74 lines (45 loc) · 2.7 KB
Raw

Contributing to Nuitka

First things

Welcome on board. Nuitka is an ambitious project. We are friendly. Join it now.

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 on how to do it properly.

  • 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 further down this page but also have a look at our pull request template.

Getting Started

Submitting a Pull Request

Pull requests are great. Here's a quick guide:

  1. Fork the repo on github.

  2. Install the pre-commit git hook

    That 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

  3. Make a new branch and base your new branch on develop.

  4. 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.

  5. Make the tests pass.

  6. Push to your fork and submit a pull request against nuitka:develop

  7. 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. Indicate work in progress with a WIP: prefix in your PR title.

All the submitted pieces including potential data must be compatible with the Apache License 2, which already says that once you are sending modified source, e.g. via pull request, you automatically license it as that too.

Submitting a Question

If you want to ask a question about a specific Nuitka aspect, please be kind and first of all..

Submitting Issues

The issue template contains the guidance on how to properly support issues. If you ignore it, likely the issue will be closed as invalid. We cannot really make guesses.