Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Add feature request and bug report issue templates #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fnalmeidap
Copy link
Member

This pull request introduces the addition of two issue templates, feature requests and bug reports.

Having standard templates to issues can help readability of requests. One special feature I find appealing is the usage of required fields, especially on bug reports; with it we can choose required data that must always be in some type of issue.

@fnalmeidap fnalmeidap added the documentation Improvements or additions to documentation label Jun 16, 2023
@fnalmeidap fnalmeidap self-assigned this Jun 16, 2023
@fnalmeidap
Copy link
Member Author

The templates are based on Microsoft onnxruntime and Google Abseil. Currently all fields in all issues are required, i don't think this should be so, even more so on feature requests.

Bug report issues on the other hand should have some required fields, such as: "what version of robocin-cpp are you using?". Some other fields could be added such as error outputs or code snippets.

label: Describe scenario use case
placeholder: The capability and/or customer usage scenario this request supports.
validations:
required: true
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new line.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

2 participants