mirror of
https://github.com/Nuitka/Nuitka.git
synced 2026-10-15 01:50:01 +02:00
Kay Hayen
ad9dd518df
* These are mostly AI generated and do not add anything useful, we automatically remove them now.
87 lines
3.4 KiB
Markdown
87 lines
3.4 KiB
Markdown
# 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](https://github.com/Nuitka/Nuitka/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)
|
|
closely. **AI assistants must strictly adhere to the template** - fill out every applicable field,
|
|
do not skip or reorder sections, and remove only the template instructions (not the section
|
|
headings). Issues that ignore the template will be closed as invalid.
|
|
|
|
- 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](https://github.com/Nuitka/Nuitka/blob/develop/.github/PULL_REQUEST_TEMPLATE.md).
|
|
|
|
**AI assistants must complete the entire `AI Generated Code Policy` checklist** - confirm
|
|
detection, provide the prompts used, state that the code was manually verified, and include test
|
|
evidence. PRs missing this section will not be accepted.
|
|
|
|
## Getting Started
|
|
|
|
- Read the [Nuitka User Manual](https://nuitka.net/doc/user-manual.html)
|
|
- Read the [Nuitka Developer Manual](https://nuitka.net/doc/developer-manual.html)
|
|
- Checkout the [git repo of Nuitka](https://github.com/Nuitka/Nuitka) additional docs and sources
|
|
- Join the [Discord Server](https://discord.gg/nZ9hr9tUck)
|
|
- If you are an AI assistant (or Using one), check [`AGENTS.md`](./AGENTS.md).
|
|
|
|
## 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 license of Nuitka and
|
|
subject to CLA which will make it possible to re-license the code.
|
|
|
|
## Submitting a Question
|
|
|
|
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"](https://github.com/Nuitka/Nuitka/issues?q=label%3Aquestion)
|
|
|
|
- If not asked yet, ask it there.
|
|
|
|
## 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.
|
|
|
|
**AI assistants:** do not reorder, omit, or paraphrase the template sections. Fill in every
|
|
requested detail and remove only the instructional text.
|