Update Documentation_issue_template.yaml
This commit is contained in:
parent
57b84d8ab3
commit
212b0279d0
|
@ -1,4 +1,4 @@
|
||||||
name: Build/Install Issue1
|
name: documentation issue
|
||||||
description: Use this template to report build/install issue
|
description: Use this template to report build/install issue
|
||||||
labels: 'type:doc-bug'
|
labels: 'type:doc-bug'
|
||||||
body:
|
body:
|
||||||
|
@ -15,89 +15,59 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Description of issue (what needs changing)
|
label: Description of issue (what needs changing)
|
||||||
description: Kinds of documentation problems
|
description: Kinds of documentation problems
|
||||||
label: asgdh
|
|
||||||
- type: input
|
- type: input
|
||||||
id: programminglang
|
id: clear_desc
|
||||||
attributes:
|
attributes:
|
||||||
label: Programming Language and version
|
label: Clear description
|
||||||
description:
|
description: For example, why should someone use this method? How is it useful?
|
||||||
placeholder: e.g. C++ 14, Python 3.6, Java
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: virtualenv
|
id: link
|
||||||
attributes:
|
attributes:
|
||||||
label: Installed using virtualenv? pip? Conda?(if python)
|
label: Correct links
|
||||||
description:
|
description: Is the link to the source code correct?
|
||||||
placeholder:
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: mediapipever
|
|
||||||
attributes:
|
|
||||||
label: MediaPipe version
|
|
||||||
description:
|
|
||||||
placeholder: e.g. 0.8.11, 0.9.1
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: bazelver
|
|
||||||
attributes:
|
|
||||||
label: Bazel version
|
|
||||||
description:
|
|
||||||
placeholder: e.g. 5.0, 5.1
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: input
|
- type: input
|
||||||
id: xcodeversion
|
id: parameter
|
||||||
attributes:
|
attributes:
|
||||||
label: XCode and Tulsi versions(if iOS)
|
label: Parameters defined
|
||||||
description:
|
description: Are all parameters defined and formatted correctly?
|
||||||
placeholder:
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: input
|
- type: input
|
||||||
id: sdkndkversion
|
id: returns
|
||||||
attributes:
|
attributes:
|
||||||
label: Android SDK and NDK versions(if android)
|
label: Returns defined
|
||||||
description:
|
description: Are return values defined?
|
||||||
placeholder:
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: dropdown
|
|
||||||
id: androidaar
|
|
||||||
attributes:
|
|
||||||
label: Android AAR(if android)
|
|
||||||
options:
|
|
||||||
- 'Yes'
|
|
||||||
- 'No'
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
- type: input
|
||||||
id: opencvversion
|
id: raises
|
||||||
attributes:
|
attributes:
|
||||||
label: OpenCV version(if running on desktop)
|
label: Raises listed and defined
|
||||||
description:
|
description: Are the errors defined? For example,
|
||||||
placeholder:
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: input
|
||||||
id: what-happened
|
id: usage
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe the problem
|
label: Usage example
|
||||||
description: Provide the exact sequence of commands / steps that you executed before running into the [problem](https://google.github.io/mediapipe/getting_started/getting_started.html)
|
description: Is there a usage example? See the API guide-on how to write testable usage examples.
|
||||||
placeholder: Tell us what you see!
|
|
||||||
value: "A bug happened!"
|
|
||||||
render: shell
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: false
|
||||||
- type: textarea
|
- type: input
|
||||||
id: code-to-reproduce
|
id: visual
|
||||||
attributes:
|
attributes:
|
||||||
label: Complete Logs
|
label: Request visuals, if applicable
|
||||||
description: Include Complete Log information or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached
|
description: Are there currently visuals? If not, will it clarify the content?
|
||||||
placeholder: Tell us what you see!
|
validations:
|
||||||
value:
|
required: false
|
||||||
render: shell
|
- type: input
|
||||||
validations:
|
id: pull
|
||||||
required: true
|
attributes:
|
||||||
|
label: Submit a pull request?
|
||||||
|
description: Are you planning to also submit a pull request to fix the issue? See the [docs](https://github.com/google/mediapipe/blob/master/CONTRIBUTING.md)
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
Loading…
Reference in New Issue
Block a user