Skip to content

Commit

Permalink
collect OS + version repro_template.ipynb, fix link to open new issue…
Browse files Browse the repository at this point in the history
… by adding &labels=bug&template=bug_report.yaml

as suggested in #3537 (comment)
  • Loading branch information
janosh committed Jan 9, 2024
1 parent 4b2171c commit ba655df
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions .devcontainer/repro_template.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,27 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"date: 2024-01-08\n",
"Python version: 3.11.6\n",
"pymatgen version: 2023.11.12\n",
"pymatgen version: 2023.11.12\n"
]
}
],
"outputs": [],
"source": [
"# Collect Python version, pymatgen version and current date\n",
"from __future__ import annotations\n",
"\n",
"import platform\n",
"import sys\n",
"from datetime import datetime\n",
"from importlib.metadata import version\n",
"\n",
"print(f\"date: {datetime.today():%Y-%m-%d}\")\n",
"print(f\"Python version: {sys.version.split()[0]}\")\n",
"print(f\"pymatgen version: {version('pymatgen')}\")"
"print(f\"pymatgen version: {version('pymatgen')}\")\n",
"print(f\"OS: {platform.system()} {platform.release()}\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Then, your code to reproduce issue goes below\n"
"## Code to reproduce issue goes below\n"
]
},
{
Expand All @@ -65,7 +56,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Now share the code and outputs in a [new GitHub issue](https://github.com/materialsproject/pymatgen/issues/new)\n"
"### Now share the code and outputs in a [new GitHub issue](https://github.com/materialsproject/pymatgen/issues/new?&labels=bug&template=bug_report.yaml)\n"
]
}
],
Expand Down

3 comments on commit ba655df

@DanielYang59
Copy link
Contributor

@DanielYang59 DanielYang59 commented on ba655df Jan 9, 2024

Choose a reason for hiding this comment

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

Thanks for the PR @janosh !

Also we should be mindful platform may or may not generate useful info, as it could just collect the env info from the codespace container (unless user decide to pull the container and run it locally). Should be fine though.

@janosh
Copy link
Member Author

@janosh janosh commented on ba655df Jan 9, 2024

Choose a reason for hiding this comment

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

i know, doesn't hurt though and helps establish what metadata we're looking for in a bug report

@DanielYang59
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes and thanks for the change!

Please sign in to comment.