averello/nuitka-mirror
1
0
Fork 0
mirror of https://github.com/Nuitka/Nuitka.git synced 2025-12-14 20:35:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixup! Fix link to issue template in CONTRIBUTING.md

Browse Source
This commit is contained in:
Kay Hayen
2025-11-20 10:30:53 +00:00
parent 419a9f9968
commit 1ea7d49762
1 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
CONTRIBUTING.md
View File

@@ -4,18 +4,18 @@
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.
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)
Please follow this
[template](https://github.com/Nuitka/Nuitka/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)
- 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).
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).
## Getting Started
@@ -32,8 +32,8 @@ Pull requests are great. Here's a quick guide:
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:
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
@@ -41,9 +41,9 @@ Pull requests are great. Here's a quick guide:
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.
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.
@@ -51,25 +51,26 @@ Pull requests are great. Here's a quick guide:
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.
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.
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..
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)
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.
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.