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

GitHub: Autoformat and clearer issue template

Browse Source
This commit is contained in:
Kay Hayen
2023-08-19 14:00:51 +02:00
parent c6c59f4176
commit bd8925946b
4 changed files with 76 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
.github/ISSUE_TEMPLATE.md vendored
View File

@@ -1,109 +1,103 @@
Before submitting an Issue, please review the [Issue Guidelines](https://github.com/Nuitka/Nuitka/blob/develop/CONTRIBUTING.md#submitting-an-issue). Before submitting an Issue, please review the
[Issue Guidelines](https://github.com/Nuitka/Nuitka/blob/develop/CONTRIBUTING.md#submitting-an-issue).
* Please check whether the bug was already reported or fixed. - Please check whether the bug was already reported or fixed.
* Please check out if the develop version of Nuitka works better for you. - Please check out if the develop version of Nuitka works better for you.
Download source, packages [from here](https://nuitka.net/doc/download.html) Download source, packages [from here](https://nuitka.net/doc/download.html) where you will also
where you will also find instructions how to do it via pip or git. find instructions how to do it via pip or git.
If you want to post a problem/bug, to help us understand and resolve your issue If you want to post a problem/bug, to help us understand and resolve your issue please check that
please check that you have provided at least the information below, and discard you have provided at least the information below, and discard up to here:
up to here:
* Nuitka version, full Python version, flavor, OS, etc. as output by *this* - Nuitka version, full Python version, flavor, OS, etc. as output by *this exact* command.
command.
> python -m nuitka --version > python -m nuitka --version
If you are not providing the full output. The issue cannot be solved and will If you are not providing the full output. The issue cannot be solved and will be considered
be considered `invalid`. It does more than you think, and we are adding more `invalid`. The command outputs more than you think, and we are adding more all the time. We do not
all the time. We do not want to left guessing or trying things out to want to left guessing or trying things out to reproduce your issue.
reproduce your issue.
* How did you install Nuitka and Python - How did you install Nuitka and Python
Did you use pip, anaconda, deb, rpm, from source, git clone, then install into Did you use pip, anaconda, deb, rpm, from source, git clone, then install into a virtualenv or
a virtualenv or not, this is very important usually and one thing, the above not, this is very important usually and one thing, the above command does not tell us (yet).
command does not tell us (yet).
* The specific PyPI names and versions - The specific PyPI names and versions
It should be taken from this output if there specific packages involved, e.g. It should be taken from this output if there specific packages involved, e.g. `numpy`, you are
`numpy`, you are expected to shorten this to the relevant ones. expected to shorten this to the relevant ones.
> python -m pip freeze > python -m pip freeze
* Many times when you get an error from Nuitka, your setup may be special - Many times when you get an error from Nuitka, your setup may be special
Then even a `print("hello world")` program will not work, please try that and Then even a `print("hello world")` program will not work, please try that and report that error
report that error instead. We do not need a report that says "Tensorflow does instead. We do not need a report that says "Tensorflow does not work" when nothing actually works
not work" when nothing actually works for you. You ought to also read the User for you. You ought to also read the User Manual and check that your setup is actually supported
Manual and check that your setup is actually supported already. already.
* Also supply a Short, Self Contained, Correct, Example - Also supply a Short, Self Contained, Correct, Example
That demonstrates the issue i.e a small piece of code which reproduces the That demonstrates the issue i.e a small piece of code which reproduces the issue and can be run
issue and can be run with out any other (or as few as possible) external with out any other (or as few as possible) external dependencies. Issues without this may will
dependencies. Issues without this may will likely be rejected without much likely be rejected without much consideration. Often this can be as simple as importing a package,
consideration. Often this can be as simple as importing a package, if this if this is a packaging issue, try that first.
is a packaging issue, try that first.
Pointers to repositories with usage of ``pipenv`` are very welcome, archives Pointers to repositories with usage of `pipenv` are very welcome, archives with examples are too,
with examples are too. This must be only source code, binaries are not used e.g. if a certain package structure is needed. This must be only source code, binaries are not
ever by us. But beware, that e.g. we cannot click around and stuff. Still do used ever by us. But beware, that e.g. we cannot click around and stuff. Still do an effort to
an effort to make the usage obvious. Having a compile script in the repo is make the usage obvious. Having a compile script in the repo is perfect.
perfect.
* Provide in your issue the Nuitka options used But this cannot be much code for non-commercial users, since that causes too much effort. We
cannot just compile your code, run it and have it download a control and command center.
Ideally use the `# nuitka-project:` options feature in the code, so options - Provide in your issue the Nuitka options used
and example code go along. Alternatively state the command line.
Ideally use the `# nuitka-project:` options feature in the code, so options and example code go
along. Alternatively state the command line.
[Nuitka Options in the code](https://nuitka.net/doc/user-manual.html#nuitka-options-in-the-code) [Nuitka Options in the code](https://nuitka.net/doc/user-manual.html#nuitka-options-in-the-code)
* Avoid unnecessary options - Avoid unnecessary options
Do not use `--onefile` if the issue also happens with `--standalone`. Minimize Do not use `--onefile` if the issue also happens with `--standalone`. Minimize the use of options
the use of options as far as you can, please. Do not disable outputs with as far as you can, please. Do not disable outputs with `--quiet` and do not disable warnings.
`--quiet` and do not disable warnings.
* Note if this is a regression - Note if this is a regression
If it used to work in an earlier version of Nuitka, please note what you know If it used to work in an earlier version of Nuitka, please note what you know about that. Since
about that. Since git bisect is a thing for which we do a lot of error to make git bisect is a thing for which we do a lot of error to make it usable, this will help
it usable, this will help dramatically to isolate the issue. dramatically to isolate the issue.
* Consider getting commercial support - Consider getting commercial support
[Nuitka commercial](https://nuitka.net/doc/commercial.html) offers [Nuitka commercial](https://nuitka.net/doc/commercial.html) offers subscriptions and priority
subscriptions and priority support. This will accelerate your problem solution support. This will accelerate your problem solution and helps to sustain Nuitka development. Also
and helps to sustain Nuitka development. Also you then have a chance to you then have a chance to provide source code of your project to us, which might simplify things,
provide source code of your project to us, which might simplify things, or pay or pay for time to solve your issues in your environment.
for time to solve your issues in your environment.
Some things are not welcome, please consider it. Some things are not welcome, please consider it.
* Do *not* post screenshots - Do *not* post screenshots
These are not welcome unless absolutely necessary, e.g. because of Qt display These are not welcome unless absolutely necessary, e.g. because of Qt display problem, instead
problem, instead capture the output of programs, so things are searchable and capture the output of programs, so things are searchable and copy&paste will work. I just plainly
copy&paste will work. I just plainly don't want to manually copy strings and don't want to manually copy strings and hope they match.
hope they match.
* Do *not* close the issue yourself, we will close things on stable releases - Do *not* close the issue yourself, we will close things on stable releases
We close issues only when they are released as a stable version, e.g. in a We close issues only when they are released as a stable version, e.g. in a hotfix or a new
hotfix or a new release, before that it will be "Done" in planning and go release, before that it will be "Done" in planning and go through `factory` and `develop` tags to
through `factory` and `develop` tags to indicate they are solved there. indicate they are solved there.
Of course, if you find out your issue is invalid, please do close it, and Of course, if you find out your issue is invalid, please do close it, and we then attach the
we then attach the `invalid` tag. `invalid` tag.
* Do *not* report against factory version - Do *not* report against factory version
Unless you were asked to test it there, it is frequently very broken, and Unless you were asked to test it there, it is frequently very broken, and there is only noise to
there is only noise to be had. Telling me about it on Discord would be a be had. Telling me about it on Discord would be a better idea.
better idea.
* Do *not* let this template remain part of the issue, it's noise. - Do *not* let this template remain part of the issue, it's noise.

7
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -13,9 +13,8 @@ Before submitting a PR, please review the guidelines:
- [ ] Correct base branch selected? Should be `develop` branch. - [ ] Correct base branch selected? Should be `develop` branch.
- [ ] Enabled commit hook or executed `./bin/autoformat-nuitka-source`. - [ ] Enabled commit hook or executed `./bin/autoformat-nuitka-source`.
- [ ] All tests still pass. Check the Developer Manual about `Running the Tests`. - [ ] All tests still pass. Check the Developer Manual about `Running the Tests`. There are GitHub
There are GitHub Actions tests that cover the most important Actions tests that cover the most important things however, and you are welcome to rely on those,
things however, and you are welcome to rely on those, but they might not but they might not cover enough.
cover enough.
- [ ] Ideally new features or fixed regressions ought to be covered via new tests. - [ ] Ideally new features or fixed regressions ought to be covered via new tests.
- [ ] Ideally new or changed features have documentation updates. - [ ] Ideally new or changed features have documentation updates.

17
CONTRIBUTING.md
View File

@@ -7,11 +7,11 @@ 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 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. 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 - If you plan on submitting an issue
Please follow this [template](https://github.com/Nuitka/Nuitka/blob/develop/.github/ISSUE_TEMPLATE.md). Please follow this [template](https://github.com/Nuitka/Nuitka/blob/develop/.github/ISSUE_TEMPLATE.md).
* If you want to open a pull request - If you want to open a pull request
Make sure to read the information on further down this page but also have a Make sure to read the information on further down this page but also have a
look at our [pull request look at our [pull request
@@ -19,16 +19,17 @@ to answer commonly asked questions regarding that, and to provide some insight o
## Getting Started ## Getting Started
* Read the [Nuitka User Manual](https://nuitka.net/doc/user-manual.html) - Read the [Nuitka User Manual](https://nuitka.net/doc/user-manual.html)
* Read the [Nuitka Developer Manual](https://nuitka.net/doc/developer-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 - Checkout the [git repo of Nuitka](https://github.com/Nuitka/Nuitka) additional docs and sources
* Join the [Discord Server](https://discord.gg/nZ9hr9tUck) - Join the [Discord Server](https://discord.gg/nZ9hr9tUck)
## Submitting a Pull Request ## Submitting a Pull Request
Pull requests are great. Here's a quick guide: Pull requests are great. Here's a quick guide:
1. Fork the repo on github. 1. Fork the repo on github.
2. Install the `pre-commit` git hook 2. Install the `pre-commit` git hook
That is going to automatically format your code as described in the That is going to automatically format your code as described in the
@@ -63,11 +64,11 @@ 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 If you want to ask a question about a specific Nuitka aspect, please be kind
and first of all.. and first of all..
* Search for existing issues - 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. - If not asked yet, ask it there.
## Submitting Issues ## Submitting Issues

1
SECURITY.md
View File

@@ -13,7 +13,6 @@ as bug free as possible.
| main | :white_check_mark: | | main | :white_check_mark: |
| develop | :white_check_mark: | | develop | :white_check_mark: |
## Reporting a Vulnerability ## Reporting a Vulnerability
When you email me at `kay.hayen@gmail.com` with a well defined report, I When you email me at `kay.hayen@gmail.com` with a well defined report, I