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

chore: pull issue templates from github.com:copier-org/.github #1151

Merged
merged 11 commits into from
May 22, 2023
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question, idea or general talk
url: https://github.com/copier-org/copier/discussions
about: Please share your thoughts or ask and answer questions here.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature request
description: Suggest an idea for this project
labels: [enhancement]

body:
- type: textarea
id: actual-situation
attributes:
label: Actual Situation
description: |
How does the user work? 💻 What is happening, why is he/she working like this, what problem is he/she encountering, why is it causing him/her frustration?

If you want, you can put a 📼 video where you record the use case that is problematic, or just some 📸 screenshots.

Don't just state the problem in the program itself. **Also explain how it impacts the user's real world**.
validations:
required: true

- type: textarea
id: desired-situation
attributes:
label: Desired Situation
description: |
What would the user want to happen instead of what is happening?

Explain it broadly, without going into details of how you would implement the solution.

Don't just think about what would **solve the problem** 💪, but also think about what would **reduce frustration** 🤩.
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: |
As humans, when we see a problem, it's hard not to think of a solution - and that's a good thing! 👷

In this section, you can propose what you think would be the ideal solution.

- You can give as many technical details as you see fit.
- You can design a draft interface of the solution.
- The most valued solutions are the MVP solutions.

But, important: your solution **is just a proposal**; don't get upset if it doesn't end up being the final solution. 😃
120 changes: 120 additions & 0 deletions .github/ISSUE_TEMPLATE/problem.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
name: Problem
description: Create a report to help us improve
labels: [bug, triage]

body:
- type: textarea
id: problem
attributes:
label: Describe the problem
description: A clear and concise description of what the bug is.
validations:
required: true

- 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

- type: textarea
id: additional_info
attributes:
label: Screenshots/screencasts/logs
description:
If applicable, add screenshots/screencasts/logs to help explain your problem.

- type: dropdown
id: env-os
attributes:
label: Operating system
options:
- macOS
- Linux
- Windows
validations:
required: true

- type: input
id: env-os-distro
attributes:
label: Operating system distribution and version
description: E.g. Ubuntu 22.04
validations:
required: true

- type: input
id: env-copier
attributes:
label: Copier version
description: |
Please run the following command and copy the output below:

```shell
copier --version
```

validations:
required: true

- type: input
id: env-python
attributes:
label: Python version
description: E.g. CPython 3.11
validations:
required: true

- type: dropdown
id: env-install
attributes:
label: Installation method
options:
- pipx+pypi
- pipx+git
- pip+pypi
- pip+git
- local build
- distro package
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem here.