Skip to content

Commit

Permalink
Improve issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mara004 committed Nov 4, 2023
1 parent db1e956 commit 0dd8e34
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 12 deletions.
11 changes: 8 additions & 3 deletions .github/ISSUE_TEMPLATE/1_pypa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: CC-BY-4.0

name: PyPA package
description: Use this if you installed pypdfium2 from an **official PyPA package**
description: Use this if you installed pypdfium2 via pip (or a similar PyPA format compatible tool)

body:

Expand All @@ -18,7 +18,7 @@ body:
label: Install Info
render: shell
description: |
To provide information about your install, please run the following commands and paste the output below
To provide information about your install, please run the following commands and paste the output into the field below.
```shell
python -m pypdfium2 -v
python -VV
Expand All @@ -27,4 +27,9 @@ body:
```
validations:
required: true

- type: checkboxes
attributes:
label: Output validity
options:
- label: I confirm that I ran all commands, and pasted the whole output
required: true
34 changes: 26 additions & 8 deletions .github/ISSUE_TEMPLATE/2_conda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,24 @@
# SPDX-License-Identifier: CC-BY-4.0

name: Conda package
description: Use this if you installed pypdfium2 from an **official conda package**
description: Use this if you installed pypdfium2 via conda

body:

- type: markdown
attributes:
value: |
#### Package origin
There may be unofficial conda packages of pypdfium2/pdfium-binaries in other channels, including anaconda or conda-forge defaults. **We do not support third-party builds, and they are not eligible for a bug report.** Please use the official packages instead.
- type: checkboxes
attributes:
label: Checklist
options:
- label: I have verified to be using the official packages from the `pypdfium2-team` and `bblanchon` channels.
required: true
- label: I understand that I may be blocked if I intentionally skip, remove, or set a fake value in a mandatory field.
required: true

- type: textarea
attributes:
label: Description
Expand All @@ -18,18 +32,22 @@ body:
label: Install Info
render: shell
description: |
To provide information about your install, please run the following commands and paste the output below.
**The commands have to be run in the conda env in question.**
To provide information about your install, please run the following commands and paste the output into the field below.
**Note, the commands have to be run in the active conda environment in question.**
```shell
python -m pypdfium2 -v
python -VV
python -c "import platform as p; print(p.platform())"
python -m pip show pypdfium2
conda info
python -m pip show pypdfium2_raw
python -m pip show pypdfium2_helpers
conda list --show-channel-urls "pypdfium2|pdfium-binaries"
conda info
```
validations:
required: true

- type: checkboxes
attributes:
label: Output validity
options:
- label: I confirm that I ran all commands **in the active conda environment in question**, and pasted the whole output
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/3_other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SPDX-FileCopyrightText: 2023 geisserml <geisserml@gmail.com>
# SPDX-License-Identifier: CC-BY-4.0

name: Other issue
description: Generic issue template

body:
- type: textarea
attributes:
label: Description
description: Please explain your problem
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pypdfium2 includes helpers to simplify common use cases, while the raw PDFium/ct
```bash
conda install pypdfium2_helpers -c bblanchon -c pypdfium2-team
```
**Beware:** There have been some third-party attempts to conda package pypdfium2 and pdfium-binaries. **Any recipes/packages that might be provided by other distributors, including `anaconda/main` or `conda-forge`, are unofficial!** See below for more info.
**Beware:** There have been some third-party attempts to conda package pypdfium2 and pdfium-binaries. **Any recipes/packages that might be provided by other distributors, including `anaconda` or `conda-forge` default channels, are unofficial!** See below for more info.

To depend on pypdfium2 in a recipe:
```yaml
Expand Down
1 change: 1 addition & 0 deletions docs/devel/changelog_staging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
<!-- List character: dash (-) -->

# Changelog for next release
- Added GitHub issue templates
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ def run_setup(modnames, pl_name, pdfium_ver):
)

if modnames == [ModuleHelpers]:
kwargs["name"] += "_helpers"
kwargs["description"] += " (helpers module)"
kwargs["install_requires"] += ["pypdfium2_raw"]
elif modnames == [ModuleRaw]:
Expand Down

0 comments on commit 0dd8e34

Please sign in to comment.