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

Issue template for "problem" is specific to Copier #3

Open
sisp opened this issue May 21, 2023 · 1 comment
Open

Issue template for "problem" is specific to Copier #3

sisp opened this issue May 21, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@sisp
Copy link
Member

sisp commented May 21, 2023

Describe the problem

The issue template for reporting problems contains Copier-specific information:

- type: textarea
id: template
attributes:
label: Template
description: Many problems are related to a specific Copier template. If you can provide a template, please do it. It can be a Git repo URL, a .zip file containing the template, or instructions to build it.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Run `copier ...`
2. Answer ...
3. Choose ...
4. See error
- type: textarea
id: logs
attributes:
label: Logs
description: Provide logs of the problem. These will typically happen when getting to the latest step explained above if Copier produces an error. It helps too if you paste your copying session.
render: console
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

Since the issue templates are managed in this project, they are inherited by all projects in the copier-org organization. This is suboptimal for projects in this organization that aren't closely related to Copier. For instance, when somebody would like to report a problem in the jinja2-jsonschema project, Copier-specific information is presented which may be confusing.

In fact, even this issue shows that the "problem" issue template is not perfectly applicable because this issue isn't about Copier and I even need to provide some info about my runtime environment. 😆

I see two options:

  1. We move the issue templates to the individual projects.
  2. We make the "problem" issue template generic.

WDYT, @yajo?

Template

n/a

To Reproduce

No response

Logs

No response

Expected behavior

The "problem" issue template should either be generic or tailored to the respective project.

Screenshots/screencasts/logs

No response

Operating system

Linux

Operating system distribution and version

Ubuntu 20.04

Copier version

7.2.0

Python version

3.10

Installation method

pipx+pypi

Additional context

n/a

@sisp sisp added the bug Something isn't working label May 21, 2023
@yajo
Copy link
Member

yajo commented May 22, 2023

OK let's go for option 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants