Skip to content

Commit

Permalink
Add GH Issue and PR Templates (#2520)
Browse files Browse the repository at this point in the history
* add bug templates

* add feature request issue template

* move to singular PR template
  • Loading branch information
inferrinizzard authored Mar 30, 2024
1 parent 36fb7fa commit 562bb54
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: New Bug Report
about: Use this template for reporting new bugs.
title: "[BUG]: bug description here"
labels: bug
---

<!--- Provide a general summary of the issue in the Title above -->

## Issue Type
<!--- Is this an issue with quicktype output, input parsing, or during runtime ? -->

## Context (Environment, Version, Language)
<!-- What input format and what target output language were you using ? -->

Input Format:
Output Language:

<!-- Please specify how you were using the library (CLI, npm package, or app.quicktype.io) and what version, if applicable -->

CLI, npm, or app.quicktype.io:
Version:

## Description
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Input Data
<!--- Please provide a snippet of your input data. -->
<!--- Please truncate if it is too large and ideally isolate to a minimum reproducible example -->

## Expected Behaviour / Output
<!--- Tell us what should happen / what output should be generated -->

## Current Behaviour / Output
<!--- Tell us what happens instead of the expected behavior / what output is currently generated -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Possible Solution
<!--- Optional, suggest a fix/reason for the bug, -->

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
# contact_links:
# - name: GitHub Community Support
# url: https://github.com/orgs/community/discussions
# about: Please ask and answer questions here.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature Request
about: Use this template for requesting new features.
title: "[FEATURE]: feature description here"
labels: enhancement
---

<!--- Provide a general summary of the feature in the Title above -->

## Context (Input, Language)
<!-- What input format and what target output language would this affect ? -->

Input Format:
Output Language:

## Description
<!--- How would this feature benefit you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Current Behaviour / Output
<!--- Tell us what happens / what output is currently generated -->

## Proposed Behaviour / Output
<!--- Tell us what should happen / what output should be generated -->

## Solution
<!-- Describe or propose a potential solution -->

## Alternatives
<!-- Please describe any alternatives you have considered and how they do or do not work for you -->

## Context
<!-- Add any additional context here, if applicable -->
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Previous Behaviour / Output
<!--- Provide an example of what was happening before your change -->

## New Behaviour / Output
<!--- Provide an example of what now happens after your change -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran, including any new unit tests --->

## Screenshots (if appropriate):

0 comments on commit 562bb54

Please sign in to comment.