-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added issue and pull request templates (#155)
- Loading branch information
Showing
5 changed files
with
187 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
name: Bug report | ||
description: File a bug report to help us improve | ||
labels: [Bug] | ||
|
||
body: | ||
- type: textarea | ||
id: describe-bug | ||
attributes: | ||
label: Describe the bug | ||
description: > | ||
Please give us a clear and concise description of what the bug is. | ||
Please include a screenshot if you are able to. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: example | ||
attributes: | ||
label: Example | ||
description: > | ||
Please provide a small and concise example to reproduce the issue. | ||
This will be automatically formatted into code, so no need for | ||
backticks. | ||
render: python | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: steps | ||
attributes: | ||
label: Steps to reproduce | ||
description: Please provide any further steps to reproduce the issue. | ||
placeholder: | | ||
1. ... | ||
2. ... | ||
3. ... | ||
- type: textarea | ||
id: expected-outcome | ||
attributes: | ||
label: Expected behaviour | ||
description: Please tell us what the expected behaviour should be been. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: checked-latest | ||
attributes: | ||
label: Latest version | ||
description: > | ||
Please ensure that you have checked that this issue occurs on the | ||
latest version of questionary. You can upgrade by running | ||
`pip install -U questionary`. | ||
options: | ||
- label: > | ||
I have checked that this issue occurs on the latest version of | ||
questionary. | ||
required: true | ||
- type: input | ||
id: questionary-version | ||
attributes: | ||
label: Questionary version | ||
description: > | ||
You can run `pip show questionary` to see the version of questionary | ||
that is installed. | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: prompt-toolkit-version | ||
attributes: | ||
label: Prompt Toolkit version | ||
description: > | ||
You can run `pip show prompt_toolkit` to see the version of Prompt | ||
Toolkit that is installed. | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: operating-system | ||
attributes: | ||
label: Operating System | ||
description: Which operating system are you using? | ||
options: | ||
- Windows | ||
- macOS | ||
- Linux | ||
- Other (please specify in description) | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
blank_issues_enabled: false | ||
|
||
contact_links: | ||
- name: Documentation | ||
url: https://questionary.readthedocs.io/ | ||
about: Please find answers to common questions here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
labels: [Enhancement] | ||
|
||
body: | ||
- type: textarea | ||
id: problem-description | ||
attributes: | ||
label: Describe the problem | ||
description: > | ||
Is your feature request related to a problem? Please provide a clear | ||
and concise description of what the problem is. | ||
placeholder: I'm always frustrated when... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: solution-description | ||
attributes: | ||
label: Describe the solution | ||
description: > | ||
Please provide a clear and concise description of the solution that you | ||
would like to see. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Alternatives considered | ||
description: > | ||
Please provide a clear and concise description of any alternative | ||
solutions or features you have considered. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: Need help | ||
description: Ask a question if you need help | ||
labels: [Question] | ||
|
||
body: | ||
- type: textarea | ||
id: question | ||
attributes: | ||
label: Question | ||
description: > | ||
Please describe the problem that you are having. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: previous-attempts | ||
attributes: | ||
label: What have you already tried? | ||
description: > | ||
Please describe any attempts that you have made to solve the problem. | ||
This might include code examples. This will help us get a better | ||
understanding of what you are trying to do. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: read-the-docs | ||
attributes: | ||
label: Read the documentation | ||
description: > | ||
Please check if your question is answered by the | ||
[documentation](https://questionary.readthedocs.io/). Don't worry if | ||
you ask a question that is already answered by the documentation - we'll | ||
just point you to the right place. | ||
options: | ||
- label: > | ||
I have checked to ensure that my question is not answered by the | ||
documentation. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
**What is the problem that this PR addresses?** | ||
<!-- Describe the rationale of your PR. --> | ||
<!-- Link all issues that it closes e.g. Closes #32 --> | ||
|
||
... | ||
|
||
**How did you solve it?** | ||
<!-- A detailed description of your implementation. --> | ||
|
||
... | ||
|
||
**Checklist** | ||
<!--- Put an `x` in all the boxes that apply. --> | ||
<!-- Automated tests validate that your PR follows our guidelines. --> | ||
<!-- If it doesn't pass, click on it to see details as to what your PR might be missing. --> | ||
|
||
- [ ] I have read the [Contributor's Guide](https://questionary.readthedocs.io/en/stable/pages/contributors.html#steps-for-submitting-code). | ||
- [ ] I will check that all automated PR checks pass before the PR gets reviewed. |