Skip to content

Update Github issue template #14268

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

Merged
merged 1 commit into from
Sep 23, 2016

Conversation

TomAugspurger
Copy link
Contributor

@TomAugspurger TomAugspurger commented Sep 21, 2016

Mostly just using the details tag to reduce some clutter in all the issues, e.g.


A small, complete example of the issue

# Your code here
def fib(n):
    return fib(n-1) + fib(n-2)

Expected Output

Nothing

Output of pd.show_versions()

## INSTALLED VERSIONS

commit: None
python: 3.5.2.final.0
python-bits: 64
OS: Darwin
OS-release: 15.6.0
machine: x86_64
processor: i386
byteorder: little
LC_ALL: None
LANG: en_US.UTF-8
LOCALE: en_US.UTF-8

pandas: 0.19.0rc1+21.ge596cbf
nose: 1.3.7
pip: 8.1.2
setuptools: 26.1.1
Cython: 0.25a0
numpy: 1.11.1
scipy: 0.18.0
statsmodels: 0.8.0rc1
xarray: 0.7.2
IPython: 5.1.0
sphinx: 1.4.6
patsy: 0.4.1
dateutil: 2.5.3
pytz: 2016.6.1
blosc: 1.4.1
bottleneck: 1.0.0
tables: 3.2.2
numexpr: 2.6.1
matplotlib: 1.5.2
openpyxl: 2.3.5
xlrd: 0.9.4
xlwt: 1.0.0
xlsxwriter: None
lxml: 3.4.4
bs4: 4.4.1
html5lib: 0.9999999
httplib2: 0.9.2
apiclient: 1.5.1
sqlalchemy: 1.0.12
pymysql: 0.7.6.None
psycopg2: 2.6.2 (dt dec pq3 ext lo64)
jinja2: 2.8
boto: 2.39.0
pandas_datareader: None

@jorisvandenbossche
Copy link
Member

+1 for the code snippet (indeed a lot of people don't do that)

What does the <details> do exactly? I don't see a difference in your top post (which uses it)

@jorisvandenbossche
Copy link
Member

jorisvandenbossche commented Sep 21, 2016

Ah, apparantly it is a firefox issue (in chrome it does work nicely! That's indeed very nice), but should be fixed in upcoming firefox (https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d)

Maybe we can adapt the details 'title' to indicate that the installed versions are in the details? No matter, there is still the title in the template above the details

@TomAugspurger
Copy link
Contributor Author

I edited the original to include a sample of what a new issue would look like.

@jreback
Copy link
Contributor

jreback commented Sep 21, 2016

lgtm


#### Expected Output

#### output of ``pd.show_versions()``
#### Output of ``pd.show_versions()``

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we also put:

# output of ``pd.show_version()``

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean. I just capitalized the 'o' here.

@@ -1,6 +1,15 @@
#### Code Sample, a copy-pastable example if possible
#### A small, complete example of the issue
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you also need # only (and not multiples), and this should be inside the quoting

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is OK to leave it like this, and it gives a bit structure to the report with those titles (and by using a lot of #, the title is not too big)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the four hashes are because one # made the titles so large.

@jorisvandenbossche
Copy link
Member

Firefox now also supports it! :-)

I am going to merge this, we can always refine later

@jorisvandenbossche jorisvandenbossche merged commit 99b5876 into pandas-dev:master Sep 23, 2016
@TomAugspurger TomAugspurger deleted the issue-template branch April 5, 2017 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants