-
Notifications
You must be signed in to change notification settings - Fork 709
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate markdownlint + issue templates (#738)
* Migrate to different markdown linter + format files based on it * Migrate to bug report forms * Update template with os information * Migrate feature requests * Migrate feature requests * Fix link * Update template * New line * Add change log * Add folder and model options to bug report template * Set required to true * Description field from markdown to textarea
- Loading branch information
1 parent
0bf9706
commit b104fc0
Showing
11 changed files
with
209 additions
and
143 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,129 @@ | ||
| name: Bug Report | ||
| description: Create a report to help us improve | ||
| title: "[Bug]: " | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe the bug | ||
| description: | | ||
| A clear and concise description of what the bug is. | ||
| > *__Note:__* Please do not submit support requests or "How to" questions here. Instead, please use our [Discussion forum](https://github.com/openvinotoolkit/anomalib/discussions/categories/q-a) | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: dataset | ||
| attributes: | ||
| label: Dataset | ||
| description: Which Dataset are you using? | ||
| options: | ||
| - N/A | ||
| - "Avenue" | ||
| - "BTec" | ||
| - "Folder" | ||
| - "MVTec" | ||
| - "UCSD" | ||
| - "Other (please specify in the text field below)" | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: model | ||
| attributes: | ||
| label: Model | ||
| description: Which model are you using? | ||
| options: | ||
| - N/A | ||
| - "CFlow" | ||
| - "CSFlow" | ||
| - "DFKDE" | ||
| - "DFM" | ||
| - "DRAEM" | ||
| - "FastFlow" | ||
| - "GANomaly" | ||
| - "PADiM" | ||
| - "PatchCore" | ||
| - "Reverse Distillation" | ||
| - "STFPM" | ||
| - "Other (please specify in the field below)" | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: to-reproduce | ||
| attributes: | ||
| label: Steps to reproduce the behavior | ||
| description: Detailed steps or any other information you think is useful to reproduce the behavior. | ||
| placeholder: | | ||
| Steps to reproduce the behavior: | ||
| 1. Install anomalib using '...' | ||
| 2. Use/modify config '....' | ||
| 3. Run using command '....' | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: os-information | ||
| attributes: | ||
| label: OS information | ||
| description: If you think OS information is necessary to reproduce the behavior, please provide it here. | ||
| value: | | ||
| OS information: | ||
| - OS: [e.g. Ubuntu 20.04] | ||
| - Python version: [e.g. 3.8.10] | ||
| - Anomalib version: [e.g. 0.3.6] | ||
| - PyTorch version: [e.g. 1.9.0] | ||
| - CUDA/cuDNN version: [e.g. 11.1] | ||
| - GPU models and configuration: [e.g. 2x GeForce RTX 3090] | ||
| - Any other relevant information: [e.g. I'm using a custom dataset] | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| description: A clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots | ||
| description: If applicable, add screenshots to help explain your problem. | ||
| - type: dropdown | ||
| id: source | ||
| attributes: | ||
| label: Pip/GitHub | ||
| description: Did you install Anomalib from pip or from GitHub? | ||
| options: | ||
| - pip | ||
| - GitHub | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version-branch | ||
| attributes: | ||
| label: What version/branch did you use? | ||
| - type: textarea | ||
| id: config | ||
| attributes: | ||
| label: Configuration YAML | ||
| description: Please paste your configuration YAML here. | ||
| render: yaml | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Logs | ||
| description: Please paste your logs here. | ||
| render: shell | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/openvinotoolkit/anomalib/blob/main/CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file was deleted.
Oops, something went wrong.
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,35 @@ | ||
| name: Feature Request | ||
| description: Suggest an idea for this project | ||
| title: "[Feature Request]: " | ||
| labels: ["Feature Request"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| We encourage our users to submit feature requests in our [Discussion forum](https://github.com/openvinotoolkit/anomalib/discussions/categories/ideas-feature-requests). You can use this template for consistency. | ||
| - type: textarea | ||
| id: concern | ||
| attributes: | ||
| label: Is your feature request related to a problem? | ||
| description: A clear and concise description of what the problem is. | ||
| placeholder: | | ||
| 1. I'm always frustrated when [...]. It would be better if we could [...] | ||
| 2. I would like to have [...] model/dataset to be supported in Anomalib. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Describe the solution you'd like | ||
| description: A clear and concise description of what you want to happen. Add screenshots or code-blocks if necessary. | ||
| placeholder: | | ||
| I would like to have [...] to do this we would need to [...] | ||
| Here is what I would like to see [...] | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional context | ||
| description: Add any other context or screenshots about the feature request 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,34 @@ | ||
| # Default state for all rules | ||
| default: true | ||
|
|
||
| # Path to configuration file to extend | ||
| extends: null | ||
|
|
||
| # MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time | ||
| MD001: true | ||
|
|
||
| # MD013/line-length - Line length | ||
| MD013: | ||
| # Number of characters | ||
| line_length: 1000 | ||
|
|
||
| # This is not useful for some files such as `CHANGELOG.md` | ||
| MD024: | ||
| # Only check sibling headings | ||
| allow_different_nesting: true | ||
| # Only check sibling headings | ||
| siblings_only: true | ||
|
|
||
| MD033: false | ||
|
|
||
| # If a page is printed, it helps if the URL is viewable. | ||
| MD034: false # Bare URL used | ||
|
|
||
| # This is needed for the anomalib tagline in the README | ||
| MD036: false # Emphasis used instead of a header | ||
|
|
||
| # Some md files have comments or links at the top of the files. | ||
| MD041: false # First line in file should be a top level header | ||
|
|
||
| # Badges have empty links | ||
| MD042: false # No empty links |
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
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
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
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
Oops, something went wrong.