mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Samuel Colvin
c73bf444db
* improved issue template and more * tweak wording * more tweaks * more tweaks * add Affected Components * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Hasan Ramezani <hasan.r67@gmail.com> Co-authored-by: Hasan Ramezani <hasan.r67@gmail.com>
93 lines
3.9 KiB
YAML
93 lines
3.9 KiB
YAML
name: 🐛 Bug
|
|
description: Report a bug or unexpected behavior in pydantic
|
|
labels: [bug, unconfirmed]
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: Thank you for contributing to pydantic! ✊
|
|
|
|
- type: checkboxes
|
|
id: checks
|
|
attributes:
|
|
label: Initial Checks
|
|
description: |
|
|
Just a few checks to make sure you need to create a bug report.
|
|
|
|
_Sorry to sound so draconian 👿; but every second spent replying to issues is time not spent improving pydantic 🙇._
|
|
options:
|
|
- label: I have searched GitHub for a duplicate issue and I'm sure this is something new
|
|
required: true
|
|
- label: I have searched Google & StackOverflow for a solution and couldn't find anything
|
|
required: true
|
|
- label: I have read and followed [the docs](https://pydantic-docs.helpmanual.io) and still think this is a bug
|
|
required: true
|
|
- label: >
|
|
I am confident that the issue is with pydantic
|
|
(not my code, or another library in the ecosystem like [FastAPI](https://fastapi.tiangolo.com) or
|
|
[mypy](https://mypy.readthedocs.io/en/stable))
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: |
|
|
Please explain what you're seeing and what you would expect to see.
|
|
|
|
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: example
|
|
attributes:
|
|
label: Example Code
|
|
description: >
|
|
If applicable, please add a self-contained,
|
|
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
|
|
demonstrating the bug.
|
|
|
|
placeholder: |
|
|
import pydantic
|
|
|
|
...
|
|
render: Python
|
|
|
|
- type: textarea
|
|
id: version
|
|
attributes:
|
|
label: Python, Pydantic & OS Version
|
|
description: |
|
|
Which version of Python & Pydantic are you using, and which Operating System?
|
|
|
|
Please run the following command and copy the output below:
|
|
|
|
```bash
|
|
python -c "import pydantic.utils; print(pydantic.utils.version_info())"
|
|
```
|
|
|
|
render: Text
|
|
validations:
|
|
required: true
|
|
|
|
- type: checkboxes
|
|
id: affected-components
|
|
attributes:
|
|
label: Affected Components
|
|
description: Which of the following parts of pydantic does this bug affect?
|
|
# keep this lis in sync with feature_request.yml
|
|
options:
|
|
- label: '[Compatibility between releases](https://pydantic-docs.helpmanual.io/changelog/)'
|
|
- label: '[Data validation/parsing](https://pydantic-docs.helpmanual.io/usage/models/#basic-model-usage)'
|
|
- label: '[Data serialization](https://pydantic-docs.helpmanual.io/usage/exporting_models/) - `.dict()` and `.json()`'
|
|
- label: '[JSON Schema](https://pydantic-docs.helpmanual.io/usage/schema/)'
|
|
- label: '[Dataclasses](https://pydantic-docs.helpmanual.io/usage/dataclasses/)'
|
|
- label: '[Model Config](https://pydantic-docs.helpmanual.io/usage/model_config/)'
|
|
- label: '[Field Types](https://pydantic-docs.helpmanual.io/usage/types/) - adding or changing a particular data type'
|
|
- label: '[Function validation decorator](https://pydantic-docs.helpmanual.io/usage/validation_decorator/)'
|
|
- label: '[Generic Models](https://pydantic-docs.helpmanual.io/usage/models/#generic-models)'
|
|
- label: '[Other Model behaviour](https://pydantic-docs.helpmanual.io/usage/models/) - `construct()`, pickling, private attributes, ORM mode'
|
|
- label: '[Settings Management](https://pydantic-docs.helpmanual.io/usage/settings/)'
|
|
- label: '[Plugins](https://pydantic-docs.helpmanual.io/) and integration with other tools - mypy, FastAPI, python-devtools, Hypothesis, VS Code, PyCharm, etc.'
|