Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Read Before Submitting Issue!] How to fill out an Issue submission. Don't waste time getting rejected. #1646

Open
MikeTheWatchGuy opened this issue Jun 28, 2019 · 0 comments

Comments

@MikeTheWatchGuy
Copy link
Collaborator

commented Jun 28, 2019

Have you looked at the documentation?? http://www.PySimpleGUI.org

If you have not first looked at the docs, then don't log an Issue. A lot of effort has gone into making it possible for you to help yourself so that you're not thrashing about guessing how sh*t works, only to be disappointed when your guesses are wrong when all you had to do was read the manual.


Have you searched the Issues, both closed and open, to see if it's already been reported?

You may find the information you need from someone else's prior submission. Go here:
https://github.com/PySimpleGUI/PySimpleGUI/issues

And type a search term in this box that you will find on that page:

image

You don't have to spend hours searching, but at least do one search.


Filling in the form

It's really important that you fill in the form. It's not asking too much of you.

You're seeking free support for a free product from a person that's giving time to you for free. Do not lose sight of that fact at this repository and the many others on GitHub.

The least you can do is fill out the 5 questions being asked of you and that you format your code.

"Least" in this case means - If you fail to at least fill in the form, then your Issue will be closed with a polite request that you fill in the form.

To get started, when you click the New Issue button, you'll see this screen and should click the green button.

SNAG-0419

Here's the form that you'll need to fill in. I've taken a few moments to write some notes for you about each section.

Type of Issues (Enhancement, Error, Bug, Question)

Obvious what to put here.

Operating System

Linux, Windows, Mac
The OS version. For Linux the distro

Python version

Be sure and get this from whatever environment you're running. If you're running a virtual environment in PyCharm, find which version of Python you're running by looking at PyCharm.
If not running a virtual environment, type python on a Windows machine and python3 on Linux and Mac machines to get the version.

PySimpleGUI Port and Version

The port is simply the GUI platform you're running on (tkinter, Qt, etc ). Type whatever you put on your import statement

To figure out exactly WHICH PySimpleGUI file you're running and to get the version of PySimpleGUI, type this sequence in a terminal. Note, if running PyCharm's virtual environment, then use the "Terminal" tab at the bottom of the PyCharm window.

This sequence will tell you the location of your PySimpleGUI file and the version number (if it's 4.0 and up):

c:\python\pycharmprojects>python
Python 3.6.2 |Anaconda, Inc.| (default, Sep 19 2017, 08:03:39) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import PySimpleGUI as sg
>>> sg.version
'4.1.0.2 Unreleased'
>>> sg
<module 'PySimpleGUI' from 'C:\\python\\PycharmProjects\\gooeyGUI\\PySimpleGUI.py'>
>>>

Notice that by typing sg alone I get the location of the .py file. VERY handy capability.

Code or partial code causing the problem

How well you write this section has a very direct impact on how quickly your problem will be worked on. Ideally, an entire program that demonstrates the problem is included. This way it can be copied from the Issue, pasted into an IDE, and executed to immediately see your problem.

Sites like StackOverflow ask you to submit the smallest working program that demonstrates the problem. You should shoot for this. If you cannot supply a working program, you need to supply ALL of the PySimpleGUI code from your program.

It's not enough to just see the line of code that you believe caused your crash. Yes, you do know the line that crashed, but, the code that is ultimately the reason behind your crash is potentially way back at the very first call you made to PySimpleGUI.

Some people try to just post the layout. That's not enough. The minimum code sections you need to supply are:

  • Your layout
  • Your call to Window
  • Everything after your call to Window up to and including your call to Window.Read()

**How to Paste Code into an Issue or any Markdown document / post (Reddit, etc) **

YOU MUST FORMAT YOUR CODE OR YOU WILL BE REJECTED.

(Simple enough for anyone, at any experience level to understand)

The quickest way to get yelled at on Reddit and to be flat rejected here to paste code without formatting it. Ever see the beautifully colored Python code that some people have in their Issue posts? It's trivial to get those results.

To post formatted code, surround your pasted code with these 2 lines:

```python
PASTE YOUR CODE HERE
```

These ``` are not single quotes, they are backquotes. You'll sometimes find them located next to the 1 key on your keyboard along with the ~.

If what you're copying isn't code, but rather text that you would like formatted using fixed width fonts, leave off the python portion of the first line.

Why is this important? No one is able to run your code if it's not formatted. It takes long enough to work on these problems, don't handicap those trying to help you by failing to do this simple, critical step. If you're bright enough to use PySimpleGUI, you're bright enough to learn how to format your code.

Screenshots

GUIs are visual things. Experience here has proven that a single screenshot can replace 4 paragraphs of text attempting to describe it.

If you have "mock ups" of how you want your screen to look, by ALL MEANS post those too!! You'll get guaranteed quick results by posting an image of "where I am now with my GUI" and another "where I want to be with my GUI".

@MikeTheWatchGuy MikeTheWatchGuy pinned this issue Jun 28, 2019

@MikeTheWatchGuy MikeTheWatchGuy changed the title How to fill out an Issue submittion [Read Before Submitting Issue] How to fill out an Issue submittion Jun 28, 2019

Repository owner deleted a comment from Aboghazala Jul 2, 2019

Repository owner deleted a comment from Aboghazala Jul 2, 2019

@MikeTheWatchGuy MikeTheWatchGuy changed the title [Read Before Submitting Issue] How to fill out an Issue submittion [Read Before Submitting Issue!] How to fill out an Issue submission. Don't waste time getting rejected. Jul 24, 2019

@PySimpleGUI PySimpleGUI referenced this issue Sep 11, 2019
7 of 7 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.